diff options
84 files changed, 9671 insertions, 5515 deletions
diff --git a/.yardoc/checksums b/.yardoc/checksums index 7617f1c1..f6e6e6dd 100644 --- a/.yardoc/checksums +++ b/.yardoc/checksums @@ -1,58 +1,59 @@ -lib/axlsx.rb 3d1e5303c404a2c20dc007eae7f14fb59a0d3aae -lib/axlsx/version.rb 921bd286d3b4f56047b9f51f11d1aa16c0bf930a -lib/axlsx/package.rb d55d5445428d99d77b62d7c742f1c284a0ec4efd -lib/axlsx/drawing/pic.rb d91e014f8e2604480437a434f714ad25d31acbff -lib/axlsx/drawing/axis.rb 8eaf645e24c1fef43a475ceb28caf5116af25736 -lib/axlsx/doc_props/app.rb c64077808d7cb6aa30472e15c600009a01f3f338 -lib/axlsx/drawing/title.rb 497e6ddeb153bb230f5bf9dc76e799b91ae2a8ed -lib/axlsx/drawing/chart.rb bd437e8cb970bbd6df7488b2187199a1f0f3e376 -lib/axlsx/stylesheet/xf.rb 97e3c67007a182fc7df22e5c06f1510cfe5c11ac -lib/axlsx/doc_props/core.rb 90ebc8086f6606af02275c27068c359a5647faf0 -lib/axlsx/drawing/series.rb 168dbadedd446ff0f28bc9a5187b571d07a8936e +lib/axlsx/stylesheet/table_styles.rb 805b00e2abd9b5e248590135067b6e43785e7240 +lib/axlsx/stylesheet/table_style.rb 3c3712b3958b6ae8f645971b0eb1fb92dd1dddbf +lib/axlsx/stylesheet/border_pr.rb e8094ee1f75f5028d2ec68dce1590ee68dbede21 +lib/axlsx/drawing/pie_3D_chart.rb f9c70bd12b697dcd51780f29c037d4659b48e479 +lib/axlsx/stylesheet/color.rb 442c205c92723c7b06f10e434ac03e2d09ab559f lib/axlsx/drawing/marker.rb 8b8c5ef799c7f56288e2951058a93db020846ea9 lib/axlsx/util/constants.rb 4dc8b1d765aa0593615a14c3761b0183be308908 -lib/axlsx/stylesheet/font.rb 1ee29414f720d26b7d484a90d8ebdaa7ecda4fa6 +lib/axlsx/stylesheet/cell_protection.rb 483e77c51f96cb52a805668b0ed40f14bf163634 +lib/axlsx/stylesheet/cell_style.rb ceb0552421cb947584c1800c9aad43536fc7715d +lib/axlsx/drawing/series_title.rb 2638d611b790db9281108110623fd71e8e79fae0 +lib/axlsx/drawing/line_series.rb c7475484fd05284520a35806ff4562d125b2b3b8 +lib/axlsx/drawing/series.rb 168dbadedd446ff0f28bc9a5187b571d07a8936e +lib/axlsx/package.rb e69e0ec5e24210423e7424af62e08f62cbeb0ba9 +lib/axlsx/stylesheet/cell_alignment.rb 71118e51e1d11ab570fc89b8fbbd639b8023a39c +lib/axlsx/content_type/default.rb 1c1a700e266964877599e8fdd28adb6771576030 +lib/axlsx/drawing/title.rb 497e6ddeb153bb230f5bf9dc76e799b91ae2a8ed +lib/axlsx/drawing/axis.rb 8eaf645e24c1fef43a475ceb28caf5116af25736 +lib/axlsx/stylesheet/table_style_element.rb 117b80432ed6191c81a9e07bd467281319d2b830 +lib/axlsx/content_type/content_type.rb 6c576e1618f99f7163fffa6b6e89e964653dcb5f +lib/axlsx/stylesheet/num_fmt.rb 796ee45611b89e8a670dcff3dd97ad9306f18048 +lib/axlsx/rels/relationships.rb 9c741e180796259bb378a789fd484fa1d8f04425 +lib/axlsx/ar.rb 3a72e7869a068f1f132674dfe746d5b9f7dac135 +lib/axlsx.rb 13120de6532e630275e55e14c36079384fd213ea +lib/axlsx/drawing/graphic_frame.rb 271e897616d85ebc069820c0d6a7dd3a716deff2 +lib/axlsx/content_type/override.rb 43ff5dbbb01fbe0237a11c3da7fa5d8e1d5b67ef +lib/axlsx/drawing/pie_series.rb 66dfb2152f3b0e80b358c7af9061beb3c4ab984d +lib/axlsx/drawing/bar_series.rb ffe5dae5292d0324442b870fb1958847da6dde5e +lib/axlsx/stylesheet/gradient_fill.rb 298777d050500c2f1f53294d8c71fce867997b3d +lib/axlsx/workbook/worksheet/row.rb ff0769adf9d4ea2b957eccf5f267a9f297cc3682 +lib/axlsx/util/simple_typed_list.rb b95f7e8d8958361cb1946b8545126b9384ff9fd2 +lib/axlsx/workbook/workbook.rb 96b55e7154132baf7dac707af3eea09583ef4d95 lib/axlsx/drawing/view_3D.rb 8a83aed740c05d28aaa0e3430c7c4d2bbc44cc61 -lib/axlsx/drawing/drawing.rb 69b5fe2e76d64958e6c6529cabf6d2f717b0df81 lib/axlsx/stylesheet/fill.rb 44c473c7eafc37690cae9de2cc11543c992752ff -lib/axlsx/util/validators.rb c70f27b943d3711fbe1244a8311789a6fad7e31e -lib/axlsx/drawing/scaling.rb 75a7a015a715bdd25f615ecdbe084d841fdc6ad0 -lib/axlsx/drawing/cat_axis.rb fde414377386d8ee7d1574e96d77a28a991ea21c -lib/axlsx/stylesheet/color.rb 442c205c92723c7b06f10e434ac03e2d09ab559f -lib/axlsx/drawing/ser_axis.rb 1f4952403738e3089e30deb266b1385679d46096 -lib/axlsx/drawing/val_axis.rb 8c1f847cff0b0c788c11b31ac55995566bef16b1 -lib/axlsx/stylesheet/border.rb cee9b6982c4a946f7caa850090f72d0d7ce0a0d2 -lib/axlsx/workbook/workbook.rb 96b55e7154132baf7dac707af3eea09583ef4d95 +lib/axlsx/stylesheet/xf.rb 97e3c67007a182fc7df22e5c06f1510cfe5c11ac +lib/axlsx/drawing/two_cell_anchor.rb 18b904330ac186f497a2c8d13e0b0de881340e09 lib/axlsx/stylesheet/styles.rb c5685e442e2a61f665e4aab479705bbc1889caed +lib/axlsx/drawing/val_axis.rb 8c1f847cff0b0c788c11b31ac55995566bef16b1 +lib/axlsx/drawing/cat_axis.rb fde414377386d8ee7d1574e96d77a28a991ea21c +lib/axlsx/stylesheet/font.rb 1ee29414f720d26b7d484a90d8ebdaa7ecda4fa6 +lib/axlsx/util/validators.rb c70f27b943d3711fbe1244a8311789a6fad7e31e +lib/axlsx/doc_props/app.rb c64077808d7cb6aa30472e15c600009a01f3f338 +lib/axlsx/workbook/worksheet/worksheet.rb cd0f6e34d8d3cf10c56af0a3c3d2de48b304126e +lib/axlsx/workbook/worksheet/cell.rb 33974b3d9807738d33943321d7864d36e1d5bcf8 lib/axlsx/rels/relationship.rb 8d279056b53ba22ff288187ff0f3d18273dcdcb7 -lib/axlsx/stylesheet/num_fmt.rb 796ee45611b89e8a670dcff3dd97ad9306f18048 -lib/axlsx/drawing/bar_series.rb ffe5dae5292d0324442b870fb1958847da6dde5e -lib/axlsx/rels/relationships.rb 9c741e180796259bb378a789fd484fa1d8f04425 -lib/axlsx/drawing/pie_series.rb 66dfb2152f3b0e80b358c7af9061beb3c4ab984d -lib/axlsx/drawing/line_series.rb c7475484fd05284520a35806ff4562d125b2b3b8 -lib/axlsx/drawing/bar_3D_chart.rb 83de47e0e9a0c7b46bdc0ea255b50f9ee8a1d1a8 -lib/axlsx/stylesheet/border_pr.rb e8094ee1f75f5028d2ec68dce1590ee68dbede21 -lib/axlsx/content_type/default.rb 1c1a700e266964877599e8fdd28adb6771576030 -lib/axlsx/drawing/series_title.rb 2638d611b790db9281108110623fd71e8e79fae0 -lib/axlsx/drawing/pie_3D_chart.rb f9c70bd12b697dcd51780f29c037d4659b48e479 +lib/axlsx/stylesheet/border.rb cee9b6982c4a946f7caa850090f72d0d7ce0a0d2 +lib/axlsx/drawing/ser_axis.rb 1f4952403738e3089e30deb266b1385679d46096 +lib/axlsx/drawing/drawing.rb 69b5fe2e76d64958e6c6529cabf6d2f717b0df81 +lib/axlsx/drawing/chart.rb bd437e8cb970bbd6df7488b2187199a1f0f3e376 +lib/axlsx/version.rb 4fb6c38b6bc649f6675c04d9ecb02bcb719f28e2 +lib/axlsx/stylesheet/gradient_stop.rb 56c3c6b030bad35ee6cff7ad3cd9207048dd4e68 lib/axlsx/drawing/val_axis_data.rb c57c0abf5abb4aca9fba774f20e2f2c04d3020e8 -lib/axlsx/drawing/graphic_frame.rb 271e897616d85ebc069820c0d6a7dd3a716deff2 -lib/axlsx/drawing/line_3D_chart.rb 77bc8e6efbe42f8928fb6ffd3c2538ff99ec2444 -lib/axlsx/content_type/override.rb 43ff5dbbb01fbe0237a11c3da7fa5d8e1d5b67ef lib/axlsx/drawing/cat_axis_data.rb f440010084afad99d97d31354f5b5a8ee8766e9b -lib/axlsx/stylesheet/cell_style.rb ceb0552421cb947584c1800c9aad43536fc7715d -lib/axlsx/util/simple_typed_list.rb b95f7e8d8958361cb1946b8545126b9384ff9fd2 -lib/axlsx/workbook/worksheet/row.rb 17cf7a468717fd6e01fddce1f00199307736adb5 -lib/axlsx/stylesheet/table_style.rb 3c3712b3958b6ae8f645971b0eb1fb92dd1dddbf +lib/axlsx/doc_props/core.rb 90ebc8086f6606af02275c27068c359a5647faf0 +lib/axlsx/drawing/pic.rb d91e014f8e2604480437a434f714ad25d31acbff +lib/axlsx/drawing/bar_3D_chart.rb 83de47e0e9a0c7b46bdc0ea255b50f9ee8a1d1a8 +lib/axlsx/drawing/scaling.rb 75a7a015a715bdd25f615ecdbe084d841fdc6ad0 lib/axlsx/drawing/one_cell_anchor.rb 523ce88a5fd0245d119a6221ef88d629ed20c51e -lib/axlsx/stylesheet/table_styles.rb 805b00e2abd9b5e248590135067b6e43785e7240 -lib/axlsx/workbook/worksheet/cell.rb 33974b3d9807738d33943321d7864d36e1d5bcf8 -lib/axlsx/drawing/two_cell_anchor.rb 18b904330ac186f497a2c8d13e0b0de881340e09 lib/axlsx/stylesheet/pattern_fill.rb 9ba1cf8983ab9fba89ca9489fd04714eb6a94a2b -lib/axlsx/stylesheet/gradient_stop.rb 56c3c6b030bad35ee6cff7ad3cd9207048dd4e68 -lib/axlsx/stylesheet/gradient_fill.rb 298777d050500c2f1f53294d8c71fce867997b3d -lib/axlsx/stylesheet/cell_alignment.rb 71118e51e1d11ab570fc89b8fbbd639b8023a39c -lib/axlsx/content_type/content_type.rb 6c576e1618f99f7163fffa6b6e89e964653dcb5f -lib/axlsx/stylesheet/cell_protection.rb 483e77c51f96cb52a805668b0ed40f14bf163634 -lib/axlsx/workbook/worksheet/worksheet.rb 0220616ef72c5bd3f7f4b94127c75a117b35b4d1 -lib/axlsx/stylesheet/table_style_element.rb 117b80432ed6191c81a9e07bd467281319d2b830 +lib/axlsx/drawing/line_3D_chart.rb 77bc8e6efbe42f8928fb6ffd3c2538ff99ec2444 diff --git a/.yardoc/objects/root.dat b/.yardoc/objects/root.dat Binary files differindex d5d8617e..f81ee655 100644 --- a/.yardoc/objects/root.dat +++ b/.yardoc/objects/root.dat diff --git a/.yardoc/proxy_types b/.yardoc/proxy_types Binary files differindex 3ba36e0a..97e24d35 100644 --- a/.yardoc/proxy_types +++ b/.yardoc/proxy_types diff --git a/Gemfile b/Gemfile new file mode 100644 index 00000000..857c670d --- /dev/null +++ b/Gemfile @@ -0,0 +1,3 @@ +source "http://rubygems.org" + +gemspec
\ No newline at end of file diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 00000000..493e4e43 --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,18 @@ +GEM + remote: http://rubygems.org/ + specs: + active_support (3.0.0) + activesupport (= 3.0.0) + activesupport (3.0.0) + nokogiri (1.5.0) + rmagick (2.13.1) + zip (2.0.2) + +PLATFORMS + ruby + +DEPENDENCIES + active_support (>= 3) + nokogiri (>= 1.4) + rmagick (>= 2) + zip (>= 2) @@ -6,7 +6,7 @@ Axlsx: Office Open XML Spreadsheet Generation **Author**: Randy Morgan **Copyright**: 2011 **License**: MIT License -**Latest Version**: 1.0.9 +**Latest Version**: 1.0.10 **Ruby Version**: 1.8.7 - 1.9.3 **Release Date**: November 26th 2011 @@ -38,6 +38,8 @@ Feature List **7. Add jpg, gif and png images to worksheets +**8. Build in mixin with Active record. simply add acts_as_xlsx to you models and they will support to_xlsx + Installing ---------- @@ -162,6 +164,58 @@ Asian Language Support end p.serialize("example8.xlsx") +Styling Columns + + p = Axlsx::Package.new + percent = p.workbook.styles.add_style :num_fmt => 9 + p.workbook.add_worksheet do |sheet| + sheet.add_row ['col 1', 'col 2', 'col 3', 'col 4'] + sheet.add_row [1, 2, 0.3, 4] + sheet.add_row [1, 2, 0.2, 4] + sheet.add_row [1, 2, 0.1, 4] + end + p.workbook.worksheets.first.col_style 2, percent, :row_offset=>1 + p.serialize("example10.xlsx") + +Styling Rows + + p = Axlsx::Package.new + p.workbook.add_worksheet do |sheet| + sheet.add_row ['col 1', 'col 2', 'col 3', 'col 4'] + sheet.add_row [1, 2, 0.3, 4] + sheet.add_row [1, 2, 0.2, 4] + sheet.add_row [1, 2, 0.1, 4] + end + head = p.workbook.styles.add_style :bg_color => "FF000000", :fg_color=>"FFFFFFFF" + percent = p.workbook.styles.add_style :num_fmt => 9 + p.workbook.worksheets.first.col_style 2, percent, :row_offset=>1 + p.workbook.worksheets.first.row_style 0, head + p.serialize("example11.xlsx") + + +Rails 3 + # 1. Add the gem to your Gemfile and bundle install + + gem 'axlsx' + + # 2. Add 'acts_as_axslx' to your model + + class MyModel < ActiveRecord::Base + acts_as_axlsx + end + + # 3. In your controlle, simply call to_xlsx against the class + + class MyModelController < ApplicationController + + #GET /posts/xlsx + def xlsx + p = MyModel.since(Time.now - 5.days).to_xlsx + p.serialize('my_model.xlsx') + send_file 'my_model.xlsx', :type=>"application/xlsx", :x_sendfile=>true + end + end + ###Documentation This gem is 100% documented with YARD, an exceptional documentation library. To see documentation for this, and all the gems installed on your system use: @@ -176,6 +230,12 @@ This gem has 100% test coverage using test/unit. To execute tests for this gem, Changelog --------- +- **October.27.11**: 1.0.10 release + - Updating gemspec to be compatible with rails3 requirements + - Added acts_as_xlsx mixin for rails3 See Examples + - Added row.style assignation for updating the cell style for an entire row + - Added col_style method to worksheet upate a the style for a column of cells + - **October.26.11**: 1.0.9 release - Updated to support ruby 1.9.3 - Updated to eliminate all warnings originating in this gem diff --git a/axlsx.gemspec b/axlsx.gemspec index a48f8417..041e5fca 100644 --- a/axlsx.gemspec +++ b/axlsx.gemspec @@ -27,10 +27,10 @@ Gem::Specification.new do |s| fl.exclude("*.gem") fl.exclude("*.xlsx") end - s.add_runtime_dependency 'nokogiri', '~> 1.4' - s.add_runtime_dependency 'active_support', '~> 3' - s.add_runtime_dependency 'rmagick', '~> 2' - s.add_runtime_dependency 'zip', '~> 2' - s.require_path = 'lib' + s.add_runtime_dependency 'nokogiri', '>= 1.4.1' + s.add_runtime_dependency 'activesupport', '>= 2.3.9' + s.add_runtime_dependency 'rmagick', '>= 2.12.2' + s.add_runtime_dependency 'zip', '~> 2.0.2' s.required_ruby_version = '>= 1.8.7' + s.require_path = 'lib' end diff --git a/doc/Axlsx.html b/doc/Axlsx.html index 05fbc258..bb177b0b 100644 --- a/doc/Axlsx.html +++ b/doc/Axlsx.html @@ -73,7 +73,7 @@ <dt class="r1 last">Defined in:</dt> <dd class="r1 last">lib/axlsx.rb<span class="defines">,<br /> - lib/axlsx/version.rb,<br /> lib/axlsx/package.rb,<br /> lib/axlsx/drawing/pic.rb,<br /> lib/axlsx/drawing/axis.rb,<br /> lib/axlsx/doc_props/app.rb,<br /> lib/axlsx/drawing/title.rb,<br /> lib/axlsx/drawing/chart.rb,<br /> lib/axlsx/stylesheet/xf.rb,<br /> lib/axlsx/doc_props/core.rb,<br /> lib/axlsx/drawing/series.rb,<br /> lib/axlsx/drawing/marker.rb,<br /> lib/axlsx/util/constants.rb,<br /> lib/axlsx/stylesheet/font.rb,<br /> lib/axlsx/drawing/view_3D.rb,<br /> lib/axlsx/drawing/drawing.rb,<br /> lib/axlsx/stylesheet/fill.rb,<br /> lib/axlsx/util/validators.rb,<br /> lib/axlsx/drawing/scaling.rb,<br /> lib/axlsx/drawing/cat_axis.rb,<br /> lib/axlsx/stylesheet/color.rb,<br /> lib/axlsx/drawing/ser_axis.rb,<br /> lib/axlsx/drawing/val_axis.rb,<br /> lib/axlsx/stylesheet/border.rb,<br /> lib/axlsx/workbook/workbook.rb,<br /> lib/axlsx/stylesheet/styles.rb,<br /> lib/axlsx/rels/relationship.rb,<br /> lib/axlsx/stylesheet/num_fmt.rb,<br /> lib/axlsx/drawing/bar_series.rb,<br /> lib/axlsx/rels/relationships.rb,<br /> lib/axlsx/drawing/pie_series.rb,<br /> lib/axlsx/drawing/line_series.rb,<br /> lib/axlsx/drawing/bar_3D_chart.rb,<br /> lib/axlsx/stylesheet/border_pr.rb,<br /> lib/axlsx/content_type/default.rb,<br /> lib/axlsx/drawing/series_title.rb,<br /> lib/axlsx/drawing/pie_3D_chart.rb,<br /> lib/axlsx/drawing/val_axis_data.rb,<br /> lib/axlsx/drawing/graphic_frame.rb,<br /> lib/axlsx/drawing/line_3D_chart.rb,<br /> lib/axlsx/content_type/override.rb,<br /> lib/axlsx/drawing/cat_axis_data.rb,<br /> lib/axlsx/stylesheet/cell_style.rb,<br /> lib/axlsx/util/simple_typed_list.rb,<br /> lib/axlsx/workbook/worksheet/row.rb,<br /> lib/axlsx/stylesheet/table_style.rb,<br /> lib/axlsx/drawing/one_cell_anchor.rb,<br /> lib/axlsx/stylesheet/table_styles.rb,<br /> lib/axlsx/workbook/worksheet/cell.rb,<br /> lib/axlsx/drawing/two_cell_anchor.rb,<br /> lib/axlsx/stylesheet/pattern_fill.rb,<br /> lib/axlsx/stylesheet/gradient_stop.rb,<br /> lib/axlsx/stylesheet/gradient_fill.rb,<br /> lib/axlsx/stylesheet/cell_alignment.rb,<br /> lib/axlsx/content_type/content_type.rb,<br /> lib/axlsx/stylesheet/cell_protection.rb,<br /> lib/axlsx/workbook/worksheet/worksheet.rb,<br /> lib/axlsx/stylesheet/table_style_element.rb</span> + lib/axlsx/ar.rb,<br /> lib/axlsx/package.rb,<br /> lib/axlsx/version.rb,<br /> lib/axlsx/drawing/pic.rb,<br /> lib/axlsx/drawing/axis.rb,<br /> lib/axlsx/drawing/chart.rb,<br /> lib/axlsx/drawing/title.rb,<br /> lib/axlsx/doc_props/app.rb,<br /> lib/axlsx/stylesheet/xf.rb,<br /> lib/axlsx/util/constants.rb,<br /> lib/axlsx/drawing/series.rb,<br /> lib/axlsx/drawing/marker.rb,<br /> lib/axlsx/doc_props/core.rb,<br /> lib/axlsx/drawing/drawing.rb,<br /> lib/axlsx/stylesheet/fill.rb,<br /> lib/axlsx/drawing/scaling.rb,<br /> lib/axlsx/util/validators.rb,<br /> lib/axlsx/stylesheet/font.rb,<br /> lib/axlsx/drawing/view_3D.rb,<br /> lib/axlsx/stylesheet/color.rb,<br /> lib/axlsx/drawing/cat_axis.rb,<br /> lib/axlsx/drawing/ser_axis.rb,<br /> lib/axlsx/drawing/val_axis.rb,<br /> lib/axlsx/workbook/workbook.rb,<br /> lib/axlsx/stylesheet/styles.rb,<br /> lib/axlsx/stylesheet/border.rb,<br /> lib/axlsx/rels/relationship.rb,<br /> lib/axlsx/drawing/bar_series.rb,<br /> lib/axlsx/drawing/pie_series.rb,<br /> lib/axlsx/rels/relationships.rb,<br /> lib/axlsx/stylesheet/num_fmt.rb,<br /> lib/axlsx/drawing/line_series.rb,<br /> lib/axlsx/drawing/pie_3D_chart.rb,<br /> lib/axlsx/stylesheet/border_pr.rb,<br /> lib/axlsx/drawing/series_title.rb,<br /> lib/axlsx/drawing/bar_3D_chart.rb,<br /> lib/axlsx/content_type/default.rb,<br /> lib/axlsx/stylesheet/cell_style.rb,<br /> lib/axlsx/content_type/override.rb,<br /> lib/axlsx/drawing/cat_axis_data.rb,<br /> lib/axlsx/drawing/val_axis_data.rb,<br /> lib/axlsx/drawing/line_3D_chart.rb,<br /> lib/axlsx/drawing/graphic_frame.rb,<br /> lib/axlsx/util/simple_typed_list.rb,<br /> lib/axlsx/workbook/worksheet/row.rb,<br /> lib/axlsx/stylesheet/table_style.rb,<br /> lib/axlsx/stylesheet/pattern_fill.rb,<br /> lib/axlsx/stylesheet/table_styles.rb,<br /> lib/axlsx/workbook/worksheet/cell.rb,<br /> lib/axlsx/drawing/one_cell_anchor.rb,<br /> lib/axlsx/drawing/two_cell_anchor.rb,<br /> lib/axlsx/stylesheet/gradient_fill.rb,<br /> lib/axlsx/stylesheet/gradient_stop.rb,<br /> lib/axlsx/stylesheet/cell_alignment.rb,<br /> lib/axlsx/content_type/content_type.rb,<br /> lib/axlsx/stylesheet/cell_protection.rb,<br /> lib/axlsx/workbook/worksheet/worksheet.rb,<br /> lib/axlsx/stylesheet/table_style_element.rb</span> </dd> </dl> @@ -81,14 +81,15 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>xlsx generation with charts, images, automated column width, customizable + <p> +xlsx generation with charts, images, automated column width, customizable styles and full schema validation. Axlsx excels at helping you generate beautiful Office Open XML Spreadsheet documents without having to understand the entire ECMA specification. Check out the README for some examples of how easy it is. Best of all, you can validate your xlsx file before serialization so you know for sure that anything generated is going -to load on your client's machine.</p> +to load on your client’s machine. +</p> </div> @@ -100,6 +101,8 @@ to load on your client's machine.</p> <p class="children"> + <strong class="modules">Modules:</strong> <span class='object_link'><a href="Axlsx/Ar.html" title="Axlsx::Ar (module)">Ar</a></span> + <strong class="classes">Classes:</strong> <span class='object_link'><a href="Axlsx/App.html" title="Axlsx::App (class)">App</a></span>, <span class='object_link'><a href="Axlsx/Axis.html" title="Axlsx::Axis (class)">Axis</a></span>, <span class='object_link'><a href="Axlsx/Bar3DChart.html" title="Axlsx::Bar3DChart (class)">Bar3DChart</a></span>, <span class='object_link'><a href="Axlsx/BarSeries.html" title="Axlsx::BarSeries (class)">BarSeries</a></span>, <span class='object_link'><a href="Axlsx/Border.html" title="Axlsx::Border (class)">Border</a></span>, <span class='object_link'><a href="Axlsx/BorderPr.html" title="Axlsx::BorderPr (class)">BorderPr</a></span>, <span class='object_link'><a href="Axlsx/CatAxis.html" title="Axlsx::CatAxis (class)">CatAxis</a></span>, <span class='object_link'><a href="Axlsx/CatAxisData.html" title="Axlsx::CatAxisData (class)">CatAxisData</a></span>, <span class='object_link'><a href="Axlsx/Cell.html" title="Axlsx::Cell (class)">Cell</a></span>, <span class='object_link'><a href="Axlsx/CellAlignment.html" title="Axlsx::CellAlignment (class)">CellAlignment</a></span>, <span class='object_link'><a href="Axlsx/CellProtection.html" title="Axlsx::CellProtection (class)">CellProtection</a></span>, <span class='object_link'><a href="Axlsx/CellStyle.html" title="Axlsx::CellStyle (class)">CellStyle</a></span>, <span class='object_link'><a href="Axlsx/Chart.html" title="Axlsx::Chart (class)">Chart</a></span>, <span class='object_link'><a href="Axlsx/Color.html" title="Axlsx::Color (class)">Color</a></span>, <span class='object_link'><a href="Axlsx/ContentType.html" title="Axlsx::ContentType (class)">ContentType</a></span>, <span class='object_link'><a href="Axlsx/Core.html" title="Axlsx::Core (class)">Core</a></span>, <span class='object_link'><a href="Axlsx/DataTypeValidator.html" title="Axlsx::DataTypeValidator (class)">DataTypeValidator</a></span>, <span class='object_link'><a href="Axlsx/Default.html" title="Axlsx::Default (class)">Default</a></span>, <span class='object_link'><a href="Axlsx/Drawing.html" title="Axlsx::Drawing (class)">Drawing</a></span>, <span class='object_link'><a href="Axlsx/Fill.html" title="Axlsx::Fill (class)">Fill</a></span>, <span class='object_link'><a href="Axlsx/Font.html" title="Axlsx::Font (class)">Font</a></span>, <span class='object_link'><a href="Axlsx/GradientFill.html" title="Axlsx::GradientFill (class)">GradientFill</a></span>, <span class='object_link'><a href="Axlsx/GradientStop.html" title="Axlsx::GradientStop (class)">GradientStop</a></span>, <span class='object_link'><a href="Axlsx/GraphicFrame.html" title="Axlsx::GraphicFrame (class)">GraphicFrame</a></span>, <span class='object_link'><a href="Axlsx/Line3DChart.html" title="Axlsx::Line3DChart (class)">Line3DChart</a></span>, <span class='object_link'><a href="Axlsx/LineSeries.html" title="Axlsx::LineSeries (class)">LineSeries</a></span>, <span class='object_link'><a href="Axlsx/Marker.html" title="Axlsx::Marker (class)">Marker</a></span>, <span class='object_link'><a href="Axlsx/NumFmt.html" title="Axlsx::NumFmt (class)">NumFmt</a></span>, <span class='object_link'><a href="Axlsx/OneCellAnchor.html" title="Axlsx::OneCellAnchor (class)">OneCellAnchor</a></span>, <span class='object_link'><a href="Axlsx/Override.html" title="Axlsx::Override (class)">Override</a></span>, <span class='object_link'><a href="Axlsx/Package.html" title="Axlsx::Package (class)">Package</a></span>, <span class='object_link'><a href="Axlsx/PatternFill.html" title="Axlsx::PatternFill (class)">PatternFill</a></span>, <span class='object_link'><a href="Axlsx/Pic.html" title="Axlsx::Pic (class)">Pic</a></span>, <span class='object_link'><a href="Axlsx/Pie3DChart.html" title="Axlsx::Pie3DChart (class)">Pie3DChart</a></span>, <span class='object_link'><a href="Axlsx/PieSeries.html" title="Axlsx::PieSeries (class)">PieSeries</a></span>, <span class='object_link'><a href="Axlsx/RegexValidator.html" title="Axlsx::RegexValidator (class)">RegexValidator</a></span>, <span class='object_link'><a href="Axlsx/Relationship.html" title="Axlsx::Relationship (class)">Relationship</a></span>, <span class='object_link'><a href="Axlsx/Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span>, <span class='object_link'><a href="Axlsx/RestrictionValidator.html" title="Axlsx::RestrictionValidator (class)">RestrictionValidator</a></span>, <span class='object_link'><a href="Axlsx/Row.html" title="Axlsx::Row (class)">Row</a></span>, <span class='object_link'><a href="Axlsx/Scaling.html" title="Axlsx::Scaling (class)">Scaling</a></span>, <span class='object_link'><a href="Axlsx/SerAxis.html" title="Axlsx::SerAxis (class)">SerAxis</a></span>, <span class='object_link'><a href="Axlsx/Series.html" title="Axlsx::Series (class)">Series</a></span>, <span class='object_link'><a href="Axlsx/SeriesTitle.html" title="Axlsx::SeriesTitle (class)">SeriesTitle</a></span>, <span class='object_link'><a href="Axlsx/Styles.html" title="Axlsx::Styles (class)">Styles</a></span>, <span class='object_link'><a href="Axlsx/TableStyle.html" title="Axlsx::TableStyle (class)">TableStyle</a></span>, <span class='object_link'><a href="Axlsx/TableStyleElement.html" title="Axlsx::TableStyleElement (class)">TableStyleElement</a></span>, <span class='object_link'><a href="Axlsx/TableStyles.html" title="Axlsx::TableStyles (class)">TableStyles</a></span>, <span class='object_link'><a href="Axlsx/Title.html" title="Axlsx::Title (class)">Title</a></span>, <span class='object_link'><a href="Axlsx/TwoCellAnchor.html" title="Axlsx::TwoCellAnchor (class)">TwoCellAnchor</a></span>, <span class='object_link'><a href="Axlsx/ValAxis.html" title="Axlsx::ValAxis (class)">ValAxis</a></span>, <span class='object_link'><a href="Axlsx/ValAxisData.html" title="Axlsx::ValAxisData (class)">ValAxisData</a></span>, <span class='object_link'><a href="Axlsx/View3D.html" title="Axlsx::View3D (class)">View3D</a></span>, <span class='object_link'><a href="Axlsx/Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span>, <span class='object_link'><a href="Axlsx/Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span>, <span class='object_link'><a href="Axlsx/Xf.html" title="Axlsx::Xf (class)">Xf</a></span> @@ -114,8 +117,9 @@ to load on your client's machine.</p> <dt id="VERSION-constant" class="">VERSION = <div class="docstring"> <div class="discussion"> - -<p>version</p> + <p> +version +</p> </div> @@ -125,13 +129,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1.0.9</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"1.0.10"</span> +</pre></dd> <dt id="ENCODING-constant" class="">ENCODING = <div class="docstring"> <div class="discussion"> - -<p>XML Encoding</p> + <p> +XML Encoding +</p> </div> @@ -141,13 +147,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>UTF-8</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"UTF-8"</span> +</pre></dd> <dt id="XML_NS-constant" class="">XML_NS = <div class="docstring"> <div class="discussion"> - -<p>spreadsheetML namespace</p> + <p> +spreadsheetML namespace +</p> </div> @@ -157,13 +165,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>http://schemas.openxmlformats.org/spreadsheetml/2006/main</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/spreadsheetml/2006/main"</span> +</pre></dd> <dt id="XML_NS_T-constant" class="">XML_NS_T = <div class="docstring"> <div class="discussion"> - -<p>content-types namespace</p> + <p> +content-types namespace +</p> </div> @@ -173,13 +183,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>http://schemas.openxmlformats.org/package/2006/content-types</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/package/2006/content-types"</span> +</pre></dd> <dt id="APP_NS-constant" class="">APP_NS = <div class="docstring"> <div class="discussion"> - -<p>extended-properties namespace</p> + <p> +extended-properties namespace +</p> </div> @@ -189,13 +201,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>http://schemas.openxmlformats.org/officeDocument/2006/extended-properties</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/officeDocument/2006/extended-properties"</span> +</pre></dd> <dt id="APP_NS_VT-constant" class="">APP_NS_VT = <div class="docstring"> <div class="discussion"> - -<p>doc props namespace</p> + <p> +doc props namespace +</p> </div> @@ -205,13 +219,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes"</span> +</pre></dd> <dt id="CORE_NS-constant" class="">CORE_NS = <div class="docstring"> <div class="discussion"> - -<p>core properties namespace</p> + <p> +core properties namespace +</p> </div> @@ -221,13 +237,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>http://schemas.openxmlformats.org/package/2006/metadata/core-properties</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/package/2006/metadata/core-properties"</span> +</pre></dd> <dt id="CORE_NS_DC-constant" class="">CORE_NS_DC = <div class="docstring"> <div class="discussion"> - -<p>dc elements (core) namespace</p> + <p> +dc elements (core) namespace +</p> </div> @@ -237,13 +255,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>http://purl.org/dc/elements/1.1/</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"http://purl.org/dc/elements/1.1/"</span> +</pre></dd> <dt id="CORE_NS_DCMIT-constant" class="">CORE_NS_DCMIT = <div class="docstring"> <div class="discussion"> - -<p>dcmit (core) namespcace</p> + <p> +dcmit (core) namespcace +</p> </div> @@ -253,13 +273,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>http://purl.org/dc/dcmitype/</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"http://purl.org/dc/dcmitype/"</span> +</pre></dd> <dt id="CORE_NS_DCT-constant" class="">CORE_NS_DCT = <div class="docstring"> <div class="discussion"> - -<p>dc terms namespace</p> + <p> +dc terms namespace +</p> </div> @@ -269,13 +291,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>http://purl.org/dc/terms/</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"http://purl.org/dc/terms/"</span> +</pre></dd> <dt id="CORE_NS_XSI-constant" class="">CORE_NS_XSI = <div class="docstring"> <div class="discussion"> - -<p>xml schema namespace</p> + <p> +xml schema namespace +</p> </div> @@ -285,13 +309,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>http://www.w3.org/2001/XMLSchema-instance</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"http://www.w3.org/2001/XMLSchema-instance"</span> +</pre></dd> <dt id="XML_NS_XDR-constant" class="">XML_NS_XDR = <div class="docstring"> <div class="discussion"> - -<p>spreadsheet drawing namespace</p> + <p> +spreadsheet drawing namespace +</p> </div> @@ -301,13 +327,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>http://schemas.openxmlformats.org/drawingml/2006/spreadsheetDrawing</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/drawingml/2006/spreadsheetDrawing"</span> +</pre></dd> <dt id="XML_NS_A-constant" class="">XML_NS_A = <div class="docstring"> <div class="discussion"> - -<p>drawing namespace</p> + <p> +drawing namespace +</p> </div> @@ -317,13 +345,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>http://schemas.openxmlformats.org/drawingml/2006/main</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/drawingml/2006/main"</span> +</pre></dd> <dt id="XML_NS_C-constant" class="">XML_NS_C = <div class="docstring"> <div class="discussion"> - -<p>chart namespace</p> + <p> +chart namespace +</p> </div> @@ -333,13 +363,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>http://schemas.openxmlformats.org/drawingml/2006/chart</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/drawingml/2006/chart"</span> +</pre></dd> <dt id="XML_NS_R-constant" class="">XML_NS_R = <div class="docstring"> <div class="discussion"> - -<p>relationships namespace</p> + <p> +relationships namespace +</p> </div> @@ -349,13 +381,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>http://schemas.openxmlformats.org/officeDocument/2006/relationships</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/officeDocument/2006/relationships"</span> +</pre></dd> <dt id="RELS_R-constant" class="">RELS_R = <div class="docstring"> <div class="discussion"> - -<p>relationships name space</p> + <p> +relationships name space +</p> </div> @@ -365,13 +399,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>http://schemas.openxmlformats.org/package/2006/relationships</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/package/2006/relationships"</span> +</pre></dd> <dt id="TABLE_R-constant" class="">TABLE_R = <div class="docstring"> <div class="discussion"> - -<p>table rels namespace</p> + <p> +table rels namespace +</p> </div> @@ -381,13 +417,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>http://schemas.openxmlformats.org/officeDocument/2006/relationships/table</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/officeDocument/2006/relationships/table"</span> +</pre></dd> <dt id="WORKBOOK_R-constant" class="">WORKBOOK_R = <div class="docstring"> <div class="discussion"> - -<p>workbook rels namespace</p> + <p> +workbook rels namespace +</p> </div> @@ -397,13 +435,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument"</span> +</pre></dd> <dt id="WORKSHEET_R-constant" class="">WORKSHEET_R = <div class="docstring"> <div class="discussion"> - -<p>worksheet rels namespace</p> + <p> +worksheet rels namespace +</p> </div> @@ -413,13 +453,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet"</span> +</pre></dd> <dt id="APP_R-constant" class="">APP_R = <div class="docstring"> <div class="discussion"> - -<p>app rels namespace</p> + <p> +app rels namespace +</p> </div> @@ -429,13 +471,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties"</span> +</pre></dd> <dt id="CORE_R-constant" class="">CORE_R = <div class="docstring"> <div class="discussion"> - -<p>core rels namespace</p> + <p> +core rels namespace +</p> </div> @@ -445,13 +489,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>http://schemas.openxmlformats.org/officeDocument/2006/relationships/metadata/core-properties</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/officeDocument/2006/relationships/metadata/core-properties"</span> +</pre></dd> <dt id="STYLES_R-constant" class="">STYLES_R = <div class="docstring"> <div class="discussion"> - -<p>styles rels namespace</p> + <p> +styles rels namespace +</p> </div> @@ -461,13 +507,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles"</span> +</pre></dd> <dt id="DRAWING_R-constant" class="">DRAWING_R = <div class="docstring"> <div class="discussion"> - -<p>drawing rels namespace</p> + <p> +drawing rels namespace +</p> </div> @@ -477,13 +525,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>http://schemas.openxmlformats.org/officeDocument/2006/relationships/drawing</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/officeDocument/2006/relationships/drawing"</span> +</pre></dd> <dt id="CHART_R-constant" class="">CHART_R = <div class="docstring"> <div class="discussion"> - -<p>chart rels namespace</p> + <p> +chart rels namespace +</p> </div> @@ -493,13 +543,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>http://schemas.openxmlformats.org/officeDocument/2006/relationships/chart</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/officeDocument/2006/relationships/chart"</span> +</pre></dd> <dt id="IMAGE_R-constant" class="">IMAGE_R = <div class="docstring"> <div class="discussion"> - -<p>image rels namespace</p> + <p> +image rels namespace +</p> </div> @@ -509,13 +561,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>http://schemas.openxmlformats.org/officeDocument/2006/relationships/image</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/officeDocument/2006/relationships/image"</span> +</pre></dd> <dt id="TABLE_CT-constant" class="">TABLE_CT = <div class="docstring"> <div class="discussion"> - -<p>table content type</p> + <p> +table content type +</p> </div> @@ -525,13 +579,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>application/vnd.openxmlformats-officedocument.spreadsheetml.table+xml</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"application/vnd.openxmlformats-officedocument.spreadsheetml.table+xml"</span> +</pre></dd> <dt id="WORKBOOK_CT-constant" class="">WORKBOOK_CT = <div class="docstring"> <div class="discussion"> - -<p>workbook content type</p> + <p> +workbook content type +</p> </div> @@ -541,13 +597,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml"</span> +</pre></dd> <dt id="APP_CT-constant" class="">APP_CT = <div class="docstring"> <div class="discussion"> - -<p>app content type</p> + <p> +app content type +</p> </div> @@ -557,13 +615,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>application/vnd.openxmlformats-officedocument.extended-properties+xml</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"application/vnd.openxmlformats-officedocument.extended-properties+xml"</span> +</pre></dd> <dt id="RELS_CT-constant" class="">RELS_CT = <div class="docstring"> <div class="discussion"> - -<p>rels content type</p> + <p> +rels content type +</p> </div> @@ -573,13 +633,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>application/vnd.openxmlformats-package.relationships+xml</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"application/vnd.openxmlformats-package.relationships+xml"</span> +</pre></dd> <dt id="STYLES_CT-constant" class="">STYLES_CT = <div class="docstring"> <div class="discussion"> - -<p>styles content type</p> + <p> +styles content type +</p> </div> @@ -589,13 +651,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>application/vnd.openxmlformats-officedocument.spreadsheetml.styles+xml</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"application/vnd.openxmlformats-officedocument.spreadsheetml.styles+xml"</span> +</pre></dd> <dt id="XML_CT-constant" class="">XML_CT = <div class="docstring"> <div class="discussion"> - -<p>xml content type</p> + <p> +xml content type +</p> </div> @@ -605,13 +669,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>application/xml</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"application/xml"</span> +</pre></dd> <dt id="WORKSHEET_CT-constant" class="">WORKSHEET_CT = <div class="docstring"> <div class="discussion"> - -<p>worksheet content type</p> + <p> +worksheet content type +</p> </div> @@ -621,13 +687,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml"</span> +</pre></dd> <dt id="SHARED_STRINGS_CT-constant" class="">SHARED_STRINGS_CT = <div class="docstring"> <div class="discussion"> - -<p>shared strings content type</p> + <p> +shared strings content type +</p> </div> @@ -637,13 +705,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>application/vnd.openxmlformats-officedocument.spreadsheetml.sharedStrings+xml</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"application/vnd.openxmlformats-officedocument.spreadsheetml.sharedStrings+xml"</span> +</pre></dd> <dt id="CORE_CT-constant" class="">CORE_CT = <div class="docstring"> <div class="discussion"> - -<p>core content type</p> + <p> +core content type +</p> </div> @@ -653,13 +723,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>application/vnd.openxmlformats-package.core-properties+xml</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"application/vnd.openxmlformats-package.core-properties+xml"</span> +</pre></dd> <dt id="CHART_CT-constant" class="">CHART_CT = <div class="docstring"> <div class="discussion"> - -<p>chart content type</p> + <p> +chart content type +</p> </div> @@ -669,13 +741,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>application/vnd.openxmlformats-officedocument.drawingml.chart+xml</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"application/vnd.openxmlformats-officedocument.drawingml.chart+xml"</span> +</pre></dd> <dt id="JPEG_CT-constant" class="">JPEG_CT = <div class="docstring"> <div class="discussion"> - -<p>jpeg content type</p> + <p> +jpeg content type +</p> </div> @@ -685,13 +759,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>image/jpeg</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"image/jpeg"</span> +</pre></dd> <dt id="GIF_CT-constant" class="">GIF_CT = <div class="docstring"> <div class="discussion"> - -<p>gif content type</p> + <p> +gif content type +</p> </div> @@ -701,13 +777,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>image/gif</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"image/gif"</span> +</pre></dd> <dt id="PNG_CT-constant" class="">PNG_CT = <div class="docstring"> <div class="discussion"> - -<p>png content type</p> + <p> +png content type +</p> </div> @@ -717,13 +795,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>image/png</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"image/png"</span> +</pre></dd> <dt id="DRAWING_CT-constant" class="">DRAWING_CT = <div class="docstring"> <div class="discussion"> - -<p>drawing content type</p> + <p> +drawing content type +</p> </div> @@ -733,13 +813,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>application/vnd.openxmlformats-officedocument.drawing+xml</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"application/vnd.openxmlformats-officedocument.drawing+xml"</span> +</pre></dd> <dt id="XML_EX-constant" class="">XML_EX = <div class="docstring"> <div class="discussion"> - -<p>xml content type extensions</p> + <p> +xml content type extensions +</p> </div> @@ -749,13 +831,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>xml</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"xml"</span> +</pre></dd> <dt id="JPEG_EX-constant" class="">JPEG_EX = <div class="docstring"> <div class="discussion"> - -<p>jpeg extension</p> + <p> +jpeg extension +</p> </div> @@ -765,13 +849,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>jpeg</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"jpeg"</span> +</pre></dd> <dt id="GIF_EX-constant" class="">GIF_EX = <div class="docstring"> <div class="discussion"> - -<p>gif extension</p> + <p> +gif extension +</p> </div> @@ -781,13 +867,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>gif</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"gif"</span> +</pre></dd> <dt id="PNG_EX-constant" class="">PNG_EX = <div class="docstring"> <div class="discussion"> - -<p>png extension</p> + <p> +png extension +</p> </div> @@ -797,13 +885,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>png</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"png"</span> +</pre></dd> <dt id="RELS_EX-constant" class="">RELS_EX = <div class="docstring"> <div class="discussion"> - -<p>rels content type extension</p> + <p> +rels content type extension +</p> </div> @@ -813,13 +903,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>rels</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"rels"</span> +</pre></dd> <dt id="WORKBOOK_PN-constant" class="">WORKBOOK_PN = <div class="docstring"> <div class="discussion"> - -<p>workbook part</p> + <p> +workbook part +</p> </div> @@ -829,13 +921,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>xl/workbook.xml</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"xl/workbook.xml"</span> +</pre></dd> <dt id="STYLES_PN-constant" class="">STYLES_PN = <div class="docstring"> <div class="discussion"> - -<p>styles part</p> + <p> +styles part +</p> </div> @@ -845,13 +939,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>styles.xml</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"styles.xml"</span> +</pre></dd> <dt id="APP_PN-constant" class="">APP_PN = <div class="docstring"> <div class="discussion"> - -<p>app part</p> + <p> +app part +</p> </div> @@ -861,13 +957,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>docProps/app.xml</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"docProps/app.xml"</span> +</pre></dd> <dt id="CORE_PN-constant" class="">CORE_PN = <div class="docstring"> <div class="discussion"> - -<p>core part</p> + <p> +core part +</p> </div> @@ -877,13 +975,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>docProps/core.xml</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"docProps/core.xml"</span> +</pre></dd> <dt id="CONTENT_TYPES_PN-constant" class="">CONTENT_TYPES_PN = <div class="docstring"> <div class="discussion"> - -<p>content types part</p> + <p> +content types part +</p> </div> @@ -893,13 +993,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>[Content_Types].xml</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"[Content_Types].xml"</span> +</pre></dd> <dt id="RELS_PN-constant" class="">RELS_PN = <div class="docstring"> <div class="discussion"> - -<p>rels part</p> + <p> +rels part +</p> </div> @@ -909,13 +1011,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>_rels/.rels</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"_rels/.rels"</span> +</pre></dd> <dt id="WORKBOOK_RELS_PN-constant" class="">WORKBOOK_RELS_PN = <div class="docstring"> <div class="discussion"> - -<p>workbook rels part</p> + <p> +workbook rels part +</p> </div> @@ -925,13 +1029,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>xl/_rels/workbook.xml.rels</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"xl/_rels/workbook.xml.rels"</span> +</pre></dd> <dt id="WORKSHEET_PN-constant" class="">WORKSHEET_PN = <div class="docstring"> <div class="discussion"> - -<p>worksheet part</p> + <p> +worksheet part +</p> </div> @@ -941,13 +1047,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>worksheets/sheet%d.xml</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"worksheets/sheet%d.xml"</span> +</pre></dd> <dt id="WORKSHEET_RELS_PN-constant" class="">WORKSHEET_RELS_PN = <div class="docstring"> <div class="discussion"> - -<p>worksheet rels part</p> + <p> +worksheet rels part +</p> </div> @@ -957,13 +1065,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>worksheets/_rels/sheet%d.xml.rels</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"worksheets/_rels/sheet%d.xml.rels"</span> +</pre></dd> <dt id="DRAWING_PN-constant" class="">DRAWING_PN = <div class="docstring"> <div class="discussion"> - -<p>drawing part</p> + <p> +drawing part +</p> </div> @@ -973,13 +1083,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>drawings/drawing%d.xml</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"drawings/drawing%d.xml"</span> +</pre></dd> <dt id="DRAWING_RELS_PN-constant" class="">DRAWING_RELS_PN = <div class="docstring"> <div class="discussion"> - -<p>drawing rels part</p> + <p> +drawing rels part +</p> </div> @@ -989,13 +1101,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>drawings/_rels/drawing%d.xml.rels</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"drawings/_rels/drawing%d.xml.rels"</span> +</pre></dd> <dt id="CHART_PN-constant" class="">CHART_PN = <div class="docstring"> <div class="discussion"> - -<p>chart part</p> + <p> +chart part +</p> </div> @@ -1005,13 +1119,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>charts/chart%d.xml</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"charts/chart%d.xml"</span> +</pre></dd> <dt id="IMAGE_PN-constant" class="">IMAGE_PN = <div class="docstring"> <div class="discussion"> - -<p>chart part</p> + <p> +chart part +</p> </div> @@ -1021,13 +1137,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>media/image%d.%s</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"media/image%d.%s"</span> +</pre></dd> <dt id="APP_XSD-constant" class="">APP_XSD = <div class="docstring"> <div class="discussion"> - -<p>App validation schema</p> + <p> +App validation schema +</p> </div> @@ -1037,13 +1155,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>lib/schema/shared-documentPropertiesExtended.xsd</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"lib/schema/shared-documentPropertiesExtended.xsd"</span> +</pre></dd> <dt id="CORE_XSD-constant" class="">CORE_XSD = <div class="docstring"> <div class="discussion"> - -<p>core validation schema</p> + <p> +core validation schema +</p> </div> @@ -1053,13 +1173,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>lib/schema/opc-coreProperties.xsd</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"lib/schema/opc-coreProperties.xsd"</span> +</pre></dd> <dt id="CONTENT_TYPES_XSD-constant" class="">CONTENT_TYPES_XSD = <div class="docstring"> <div class="discussion"> - -<p>content types validation schema</p> + <p> +content types validation schema +</p> </div> @@ -1069,13 +1191,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>lib/schema/opc-contentTypes.xsd</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"lib/schema/opc-contentTypes.xsd"</span> +</pre></dd> <dt id="RELS_XSD-constant" class="">RELS_XSD = <div class="docstring"> <div class="discussion"> - -<p>rels validation schema</p> + <p> +rels validation schema +</p> </div> @@ -1085,13 +1209,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>lib/schema/opc-relationships.xsd</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"lib/schema/opc-relationships.xsd"</span> +</pre></dd> <dt id="SML_XSD-constant" class="">SML_XSD = <div class="docstring"> <div class="discussion"> - -<p>spreadsheetML validation schema</p> + <p> +spreadsheetML validation schema +</p> </div> @@ -1101,13 +1227,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>lib/schema/sml.xsd</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"lib/schema/sml.xsd"</span> +</pre></dd> <dt id="DRAWING_XSD-constant" class="">DRAWING_XSD = <div class="docstring"> <div class="discussion"> - -<p>drawing validation schema</p> + <p> +drawing validation schema +</p> </div> @@ -1117,13 +1245,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>lib/schema/dml-spreadsheetDrawing.xsd</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"lib/schema/dml-spreadsheetDrawing.xsd"</span> +</pre></dd> <dt id="NUM_FMT_PERCENT-constant" class="">NUM_FMT_PERCENT = <div class="docstring"> <div class="discussion"> - -<p>number format id for pecentage formatting using the default formatting id.</p> + <p> +number format id for pecentage formatting using the default formatting id. +</p> </div> @@ -1133,13 +1263,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='int'>9</span></pre></dd> + <dd><pre class="code"><span class='integer val'>9</span> +</pre></dd> <dt id="NUM_FMT_YYYYMMDD-constant" class="">NUM_FMT_YYYYMMDD = <div class="docstring"> <div class="discussion"> - -<p>number format id for date format like 2011/11/13</p> + <p> +number format id for date format like 2011/11/13 +</p> </div> @@ -1149,13 +1281,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='int'>100</span></pre></dd> + <dd><pre class="code"><span class='integer val'>100</span> +</pre></dd> <dt id="NUM_FMT_YYYYMMDDHHMMSS-constant" class="">NUM_FMT_YYYYMMDDHHMMSS = <div class="docstring"> <div class="discussion"> - -<p>number format id for time format the creates 2011/11/13 12:23:10</p> + <p> +number format id for time format the creates 2011/11/13 12:23:10 +</p> </div> @@ -1165,13 +1299,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='int'>101</span></pre></dd> + <dd><pre class="code"><span class='integer val'>101</span> +</pre></dd> <dt id="STYLE_THIN_BORDER-constant" class="">STYLE_THIN_BORDER = <div class="docstring"> <div class="discussion"> - -<p>cellXfs id for thin borders around the cell</p> + <p> +cellXfs id for thin borders around the cell +</p> </div> @@ -1181,13 +1317,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='int'>1</span></pre></dd> + <dd><pre class="code"><span class='integer val'>1</span> +</pre></dd> <dt id="ERR_RESTRICTION-constant" class="">ERR_RESTRICTION = <div class="docstring"> <div class="discussion"> - -<p>error messages RestrictionValidor</p> + <p> +error messages RestrictionValidor +</p> </div> @@ -1197,13 +1335,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Invalid Data: %s. %s must be one of %s.</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"Invalid Data: %s. %s must be one of %s."</span> +</pre></dd> <dt id="ERR_TYPE-constant" class="">ERR_TYPE = <div class="docstring"> <div class="discussion"> - -<p>error message DataTypeValidator</p> + <p> +error message DataTypeValidator +</p> </div> @@ -1213,13 +1353,15 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Invalid Data %s for %s. must be %s.</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"Invalid Data %s for %s. must be %s."</span> +</pre></dd> <dt id="ERR_REGEX-constant" class="">ERR_REGEX = <div class="docstring"> <div class="discussion"> - -<p>error message for RegexValidator</p> + <p> +error message for RegexValidator +</p> </div> @@ -1229,7 +1371,8 @@ to load on your client's machine.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Invalid Data. %s does not match %s.</span><span class='tstring_end'>"</span></span></pre></dd> + <dd><pre class="code"><span class='string val'>"Invalid Data. %s does not match %s."</span> +</pre></dd> </dl> @@ -1262,8 +1405,9 @@ to load on your client's machine.</p> - <span class="summary_desc"><div class='inline'> -<p>determines the cell range for the items provided.</p> + <span class="summary_desc"><div class='inline'><p> +determines the cell range for the items provided. +</p> </div></span> </li> @@ -1285,9 +1429,10 @@ to load on your client's machine.</p> - <span class="summary_desc"><div class='inline'> -<p>Requires that the value is a form that can be evaluated as a boolean in an -xml document.</p> + <span class="summary_desc"><div class='inline'><p> +Requires that the value is a form that can be evaluated as a boolean in an +xml document. +</p> </div></span> </li> @@ -1309,10 +1454,11 @@ xml document.</p> - <span class="summary_desc"><div class='inline'> -<p>Requires that the value is a valid content_type TABLE_CT, WORKBOOK_CT, + <span class="summary_desc"><div class='inline'><p> +Requires that the value is a valid content_type TABLE_CT, WORKBOOK_CT, APP_CT, RELS_CT, STYLES_CT, XML_CT, WORKSHEET_CT, SHARED_STRINGS_CT, -CORE_CT, CHART_CT, DRAWING_CT are allowed.</p> +CORE_CT, CHART_CT, DRAWING_CT are allowed. +</p> </div></span> </li> @@ -1334,8 +1480,9 @@ CORE_CT, CHART_CT, DRAWING_CT are allowed.</p> - <span class="summary_desc"><div class='inline'> -<p>Requires that the value is a Float.</p> + <span class="summary_desc"><div class='inline'><p> +Requires that the value is a Float. +</p> </div></span> </li> @@ -1357,8 +1504,9 @@ CORE_CT, CHART_CT, DRAWING_CT are allowed.</p> - <span class="summary_desc"><div class='inline'> -<p>Requires that the value is a gradient_type.</p> + <span class="summary_desc"><div class='inline'><p> +Requires that the value is a gradient_type. +</p> </div></span> </li> @@ -1380,10 +1528,11 @@ CORE_CT, CHART_CT, DRAWING_CT are allowed.</p> - <span class="summary_desc"><div class='inline'> -<p>Requires that the value is a valid horizontal_alignment :general, :left, + <span class="summary_desc"><div class='inline'><p> +Requires that the value is a valid horizontal_alignment :general, :left, :center, :right, :fill, :justify, :centerContinuous, :distributed are -allowed.</p> +allowed. +</p> </div></span> </li> @@ -1405,8 +1554,9 @@ allowed.</p> - <span class="summary_desc"><div class='inline'> -<p>Requires that the value is a Fixnum or Integer.</p> + <span class="summary_desc"><div class='inline'><p> +Requires that the value is a Fixnum or Integer. +</p> </div></span> </li> @@ -1428,8 +1578,9 @@ allowed.</p> - <span class="summary_desc"><div class='inline'> -<p>Requires that the value is valid pattern type.</p> + <span class="summary_desc"><div class='inline'><p> +Requires that the value is valid pattern type. +</p> </div></span> </li> @@ -1451,10 +1602,11 @@ allowed.</p> - <span class="summary_desc"><div class='inline'> -<p>Requires that the value is a valid relationship_type XML_NS_R, TABLE_R, + <span class="summary_desc"><div class='inline'><p> +Requires that the value is a valid relationship_type XML_NS_R, TABLE_R, WORKBOOK_R, WORKSHEET_R, APP_R, RELS_R, CORE_R, STYLES_R, CHART_R, -DRAWING_R are allowed.</p> +DRAWING_R are allowed. +</p> </div></span> </li> @@ -1476,8 +1628,9 @@ DRAWING_R are allowed.</p> - <span class="summary_desc"><div class='inline'> -<p>Requires that the value is a String.</p> + <span class="summary_desc"><div class='inline'><p> +Requires that the value is a String. +</p> </div></span> </li> @@ -1499,8 +1652,8 @@ DRAWING_R are allowed.</p> - <span class="summary_desc"><div class='inline'> -<p>Requires that the value is a valid table element type :wholeTable, + <span class="summary_desc"><div class='inline'><p> +Requires that the value is a valid table element type :wholeTable, :headerRow, :totalRow, :firstColumn, :lastColumn, :firstRowStripe, :secondRowStripe, :firstColumnStripe, :secondColumnStripe, :firstHeaderCell, :lastHeaderCell, :firstTotalCell, :lastTotalCell, @@ -1508,7 +1661,8 @@ DRAWING_R are allowed.</p> :firstSubtotalRow, :secondSubtotalRow, :thirdSubtotalRow, :blankRow, :firstColumnSubheading, :secondColumnSubheading, :thirdColumnSubheading, :firstRowSubheading, :secondRowSubheading, :thirdRowSubheading, -:pageFieldLabels, :pageFieldValues are allowed.</p> +:pageFieldLabels, :pageFieldValues are allowed. +</p> </div></span> </li> @@ -1530,9 +1684,10 @@ DRAWING_R are allowed.</p> - <span class="summary_desc"><div class='inline'> -<p>Requires that the value is a Fixnum or Integer and is greater or equal to -0.</p> + <span class="summary_desc"><div class='inline'><p> +Requires that the value is a Fixnum or Integer and is greater or equal to +0. +</p> </div></span> </li> @@ -1554,9 +1709,10 @@ DRAWING_R are allowed.</p> - <span class="summary_desc"><div class='inline'> -<p>Requires that the value is a valid vertical_alignment :top, :center, -:bottom, :justify, :distributed are allowed.</p> + <span class="summary_desc"><div class='inline'><p> +Requires that the value is a valid vertical_alignment :top, :center, +:bottom, :justify, :distributed are allowed. +</p> </div></span> </li> @@ -1580,8 +1736,9 @@ DRAWING_R are allowed.</p> </p><div class="docstring"> <div class="discussion"> - -<p>determines the cell range for the items provided</p> + <p> +determines the cell range for the items provided +</p> </div> @@ -1595,24 +1752,25 @@ DRAWING_R are allowed.</p> <pre class="lines"> -36 37 38 39 40 41 -42</pre> +42 +43</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx.rb', line 36</span> - -<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id cell_range'>cell_range</span><span class='lparen'>(</span><span class='id items'>items</span><span class='rparen'>)</span> - <span class='kw'>return</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='id items'>items</span><span class='period'>.</span><span class='id first'>first</span><span class='period'>.</span><span class='id is_a?'>is_a?</span> <span class='const'>Cell</span> - <span class='id ref'>ref</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id items'>items</span><span class='period'>.</span><span class='id first'>first</span><span class='period'>.</span><span class='id row'>row</span><span class='period'>.</span><span class='id worksheet'>worksheet</span><span class='period'>.</span><span class='id name'>name</span><span class='rbrace'>}</span><span class='tstring_content'>!</span><span class='tstring_end'>"</span></span> <span class='op'>+</span> - <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id items'>items</span><span class='period'>.</span><span class='id first'>first</span><span class='period'>.</span><span class='id r_abs'>r_abs</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span> - <span class='id ref'>ref</span> <span class='op'>+=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span><span class='id items'>items</span><span class='period'>.</span><span class='id last'>last</span><span class='period'>.</span><span class='id r_abs'>r_abs</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id items'>items</span><span class='period'>.</span><span class='id size'>size</span> <span class='op'>></span> <span class='int'>1</span> - <span class='id ref'>ref</span> -<span class='kw'>end</span></pre> + <pre class="code"><span class="info file"># File 'lib/axlsx.rb', line 37</span> + +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='cell_range identifier id'>cell_range</span><span class='lparen token'>(</span><span class='items identifier id'>items</span><span class='rparen token'>)</span> + <span class='return return kw'>return</span> <span class='string val'>""</span> <span class='unless unless_mod kw'>unless</span> <span class='items identifier id'>items</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span> <span class='Cell constant id'>Cell</span> + <span class='ref identifier id'>ref</span> <span class='assign token'>=</span> <span class='dstring node'>"#{items.first.row.worksheet.name}!"</span> <span class='plus op'>+</span> + <span class='dstring node'>"#{items.first.r_abs}"</span> + <span class='ref identifier id'>ref</span> <span class='opasgn op'>+=</span> <span class='dstring node'>":#{items.last.r_abs}"</span> <span class='if if_mod kw'>if</span> <span class='items identifier id'>items</span><span class='dot token'>.</span><span class='size identifier id'>size</span> <span class='gt op'>></span> <span class='integer val'>1</span> + <span class='ref identifier id'>ref</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1627,11 +1785,13 @@ DRAWING_R are allowed.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Requires that the value is a form that can be evaluated as a boolean in an + <p> +Requires that the value is a form that can be evaluated as a boolean in an xml document. The value must be an instance of Fixnum, String, Integer, -Symbol, TrueClass or FalseClass and it must be one of 0, 1, "true", -"false", :true, :false, true, false, "0", or "1"</p> +Symbol, TrueClass or FalseClass and it must be one of 0, 1, +"true", "false", :true, :false, true, false, +"0", or "1" +</p> </div> @@ -1650,8 +1810,9 @@ Symbol, TrueClass or FalseClass and it must be one of 0, 1, "true", — - <div class='inline'> -<p>The value validated</p> + <div class='inline'><p> +The value validated +</p> </div> </li> @@ -1672,9 +1833,10 @@ Symbol, TrueClass or FalseClass and it must be one of 0, 1, "true", <td> <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 65</span> -<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id validate_boolean'>validate_boolean</span><span class='lparen'>(</span><span class='id v'>v</span><span class='rparen'>)</span> - <span class='const'>DataTypeValidator</span><span class='period'>.</span><span class='id validate'>validate</span><span class='lparen'>(</span><span class='symbol'>:boolean</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='const'>Fixnum</span><span class='comma'>,</span> <span class='const'>String</span><span class='comma'>,</span> <span class='const'>Integer</span><span class='comma'>,</span> <span class='const'>Symbol</span><span class='comma'>,</span> <span class='const'>TrueClass</span><span class='comma'>,</span> <span class='const'>FalseClass</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id v'>v</span><span class='comma'>,</span> <span class='id lambda'>lambda</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id arg'>arg</span><span class='op'>|</span> <span class='lbracket'>[</span><span class='int'>0</span><span class='comma'>,</span> <span class='int'>1</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>true</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>false</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='symbol'>:true</span><span class='comma'>,</span> <span class='symbol'>:false</span><span class='comma'>,</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>0</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id include?'>include?</span><span class='lparen'>(</span><span class='id arg'>arg</span><span class='rparen'>)</span> <span class='rbrace'>}</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate_boolean identifier id'>validate_boolean</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='DataTypeValidator constant id'>DataTypeValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='lparen token'>(</span><span class='symbol val'>:boolean</span><span class='comma token'>,</span> <span class='lbrack token'>[</span><span class='Fixnum constant id'>Fixnum</span><span class='comma token'>,</span> <span class='String constant id'>String</span><span class='comma token'>,</span> <span class='Integer constant id'>Integer</span><span class='comma token'>,</span> <span class='Symbol constant id'>Symbol</span><span class='comma token'>,</span> <span class='TrueClass constant id'>TrueClass</span><span class='comma token'>,</span> <span class='FalseClass constant id'>FalseClass</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='comma token'>,</span> <span class='lambda identifier id'>lambda</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='arg identifier id'>arg</span><span class='bitor op'>|</span> <span class='lbrack token'>[</span><span class='integer val'>0</span><span class='comma token'>,</span> <span class='integer val'>1</span><span class='comma token'>,</span> <span class='string val'>"true"</span><span class='comma token'>,</span> <span class='string val'>"false"</span><span class='comma token'>,</span> <span class='symbol val'>:true</span><span class='comma token'>,</span> <span class='symbol val'>:false</span><span class='comma token'>,</span> <span class='true true kw'>true</span><span class='comma token'>,</span> <span class='false false kw'>false</span><span class='comma token'>,</span> <span class='string val'>"0"</span><span class='comma token'>,</span> <span class='string val'>"1"</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='include? fid id'>include?</span><span class='lparen token'>(</span><span class='arg identifier id'>arg</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1689,10 +1851,11 @@ Symbol, TrueClass or FalseClass and it must be one of 0, 1, "true", </p><div class="docstring"> <div class="discussion"> - -<p>Requires that the value is a valid content_type TABLE_CT, WORKBOOK_CT, + <p> +Requires that the value is a valid content_type TABLE_CT, WORKBOOK_CT, APP_CT, RELS_CT, STYLES_CT, XML_CT, WORKSHEET_CT, SHARED_STRINGS_CT, -CORE_CT, CHART_CT, DRAWING_CT are allowed</p> +CORE_CT, CHART_CT, DRAWING_CT are allowed +</p> </div> @@ -1711,8 +1874,9 @@ CORE_CT, CHART_CT, DRAWING_CT are allowed</p> — - <div class='inline'> -<p>The value validated</p> + <div class='inline'><p> +The value validated +</p> </div> </li> @@ -1733,9 +1897,10 @@ CORE_CT, CHART_CT, DRAWING_CT are allowed</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 114</span> -<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id validate_content_type'>validate_content_type</span><span class='lparen'>(</span><span class='id v'>v</span><span class='rparen'>)</span> - <span class='const'>RestrictionValidator</span><span class='period'>.</span><span class='id validate'>validate</span> <span class='symbol'>:content_type</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='const'>TABLE_CT</span><span class='comma'>,</span> <span class='const'>WORKBOOK_CT</span><span class='comma'>,</span> <span class='const'>APP_CT</span><span class='comma'>,</span> <span class='const'>RELS_CT</span><span class='comma'>,</span> <span class='const'>STYLES_CT</span><span class='comma'>,</span> <span class='const'>XML_CT</span><span class='comma'>,</span> <span class='const'>WORKSHEET_CT</span><span class='comma'>,</span> <span class='const'>SHARED_STRINGS_CT</span><span class='comma'>,</span> <span class='const'>CORE_CT</span><span class='comma'>,</span> <span class='const'>CHART_CT</span><span class='comma'>,</span> <span class='const'>JPEG_CT</span><span class='comma'>,</span> <span class='const'>GIF_CT</span><span class='comma'>,</span> <span class='const'>PNG_CT</span><span class='comma'>,</span> <span class='const'>DRAWING_CT</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id v'>v</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate_content_type identifier id'>validate_content_type</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='RestrictionValidator constant id'>RestrictionValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='symbol val'>:content_type</span><span class='comma token'>,</span> <span class='lbrack token'>[</span><span class='TABLE_CT constant id'>TABLE_CT</span><span class='comma token'>,</span> <span class='WORKBOOK_CT constant id'>WORKBOOK_CT</span><span class='comma token'>,</span> <span class='APP_CT constant id'>APP_CT</span><span class='comma token'>,</span> <span class='RELS_CT constant id'>RELS_CT</span><span class='comma token'>,</span> <span class='STYLES_CT constant id'>STYLES_CT</span><span class='comma token'>,</span> <span class='XML_CT constant id'>XML_CT</span><span class='comma token'>,</span> <span class='WORKSHEET_CT constant id'>WORKSHEET_CT</span><span class='comma token'>,</span> <span class='SHARED_STRINGS_CT constant id'>SHARED_STRINGS_CT</span><span class='comma token'>,</span> <span class='CORE_CT constant id'>CORE_CT</span><span class='comma token'>,</span> <span class='CHART_CT constant id'>CHART_CT</span><span class='comma token'>,</span> <span class='JPEG_CT constant id'>JPEG_CT</span><span class='comma token'>,</span> <span class='GIF_CT constant id'>GIF_CT</span><span class='comma token'>,</span> <span class='PNG_CT constant id'>PNG_CT</span><span class='comma token'>,</span> <span class='DRAWING_CT constant id'>DRAWING_CT</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='v identifier id'>v</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1750,8 +1915,9 @@ CORE_CT, CHART_CT, DRAWING_CT are allowed</p> </p><div class="docstring"> <div class="discussion"> - -<p>Requires that the value is a Float</p> + <p> +Requires that the value is a Float +</p> </div> @@ -1770,8 +1936,9 @@ CORE_CT, CHART_CT, DRAWING_CT are allowed</p> — - <div class='inline'> -<p>The value validated</p> + <div class='inline'><p> +The value validated +</p> </div> </li> @@ -1792,9 +1959,10 @@ CORE_CT, CHART_CT, DRAWING_CT are allowed</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 77</span> -<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id validate_float'>validate_float</span><span class='lparen'>(</span><span class='id v'>v</span><span class='rparen'>)</span> - <span class='const'>DataTypeValidator</span><span class='period'>.</span><span class='id validate'>validate</span> <span class='symbol'>:float</span><span class='comma'>,</span> <span class='const'>Float</span><span class='comma'>,</span> <span class='id v'>v</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate_float identifier id'>validate_float</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='DataTypeValidator constant id'>DataTypeValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='symbol val'>:float</span><span class='comma token'>,</span> <span class='Float constant id'>Float</span><span class='comma token'>,</span> <span class='v identifier id'>v</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1809,9 +1977,10 @@ CORE_CT, CHART_CT, DRAWING_CT are allowed</p> </p><div class="docstring"> <div class="discussion"> - -<p>Requires that the value is a gradient_type. valid types are :linear and -:path</p> + <p> +Requires that the value is a gradient_type. valid types are :linear and +:path +</p> </div> @@ -1830,8 +1999,9 @@ CORE_CT, CHART_CT, DRAWING_CT are allowed</p> — - <div class='inline'> -<p>The value validated</p> + <div class='inline'><p> +The value validated +</p> </div> </li> @@ -1852,9 +2022,10 @@ CORE_CT, CHART_CT, DRAWING_CT are allowed</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 93</span> -<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id validate_gradient_type'>validate_gradient_type</span><span class='lparen'>(</span><span class='id v'>v</span><span class='rparen'>)</span> - <span class='const'>RestrictionValidator</span><span class='period'>.</span><span class='id validate'>validate</span> <span class='symbol'>:gradient_type</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='symbol'>:linear</span><span class='comma'>,</span> <span class='symbol'>:path</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id v'>v</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate_gradient_type identifier id'>validate_gradient_type</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='RestrictionValidator constant id'>RestrictionValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='symbol val'>:gradient_type</span><span class='comma token'>,</span> <span class='lbrack token'>[</span><span class='symbol val'>:linear</span><span class='comma token'>,</span> <span class='symbol val'>:path</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='v identifier id'>v</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1869,10 +2040,11 @@ CORE_CT, CHART_CT, DRAWING_CT are allowed</p> </p><div class="docstring"> <div class="discussion"> - -<p>Requires that the value is a valid horizontal_alignment :general, :left, + <p> +Requires that the value is a valid horizontal_alignment :general, :left, :center, :right, :fill, :justify, :centerContinuous, :distributed are -allowed</p> +allowed +</p> </div> @@ -1891,8 +2063,9 @@ allowed</p> — - <div class='inline'> -<p>The value validated</p> + <div class='inline'><p> +The value validated +</p> </div> </li> @@ -1913,9 +2086,10 @@ allowed</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 100</span> -<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id validate_horizontal_alignment'>validate_horizontal_alignment</span><span class='lparen'>(</span><span class='id v'>v</span><span class='rparen'>)</span> - <span class='const'>RestrictionValidator</span><span class='period'>.</span><span class='id validate'>validate</span> <span class='symbol'>:horizontal_alignment</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='symbol'>:general</span><span class='comma'>,</span> <span class='symbol'>:left</span><span class='comma'>,</span> <span class='symbol'>:center</span><span class='comma'>,</span> <span class='symbol'>:right</span><span class='comma'>,</span> <span class='symbol'>:fill</span><span class='comma'>,</span> <span class='symbol'>:justify</span><span class='comma'>,</span> <span class='symbol'>:centerContinuous</span><span class='comma'>,</span> <span class='symbol'>:distributed</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id v'>v</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate_horizontal_alignment identifier id'>validate_horizontal_alignment</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='RestrictionValidator constant id'>RestrictionValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='symbol val'>:horizontal_alignment</span><span class='comma token'>,</span> <span class='lbrack token'>[</span><span class='symbol val'>:general</span><span class='comma token'>,</span> <span class='symbol val'>:left</span><span class='comma token'>,</span> <span class='symbol val'>:center</span><span class='comma token'>,</span> <span class='symbol val'>:right</span><span class='comma token'>,</span> <span class='symbol val'>:fill</span><span class='comma token'>,</span> <span class='symbol val'>:justify</span><span class='comma token'>,</span> <span class='symbol val'>:centerContinuous</span><span class='comma token'>,</span> <span class='symbol val'>:distributed</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='v identifier id'>v</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1930,8 +2104,9 @@ allowed</p> </p><div class="docstring"> <div class="discussion"> - -<p>Requires that the value is a Fixnum or Integer</p> + <p> +Requires that the value is a Fixnum or Integer +</p> </div> @@ -1950,8 +2125,9 @@ allowed</p> — - <div class='inline'> -<p>The value validated</p> + <div class='inline'><p> +The value validated +</p> </div> </li> @@ -1972,9 +2148,10 @@ allowed</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 57</span> -<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id validate_int'>validate_int</span><span class='lparen'>(</span><span class='id v'>v</span><span class='rparen'>)</span> - <span class='const'>DataTypeValidator</span><span class='period'>.</span><span class='id validate'>validate</span> <span class='symbol'>:unsigned_int</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='const'>Fixnum</span><span class='comma'>,</span> <span class='const'>Integer</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id v'>v</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate_int identifier id'>validate_int</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='DataTypeValidator constant id'>DataTypeValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='symbol val'>:unsigned_int</span><span class='comma token'>,</span> <span class='lbrack token'>[</span><span class='Fixnum constant id'>Fixnum</span><span class='comma token'>,</span> <span class='Integer constant id'>Integer</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='v identifier id'>v</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1989,12 +2166,13 @@ allowed</p> </p><div class="docstring"> <div class="discussion"> - -<p>Requires that the value is valid pattern type. valid pattern types must be + <p> +Requires that the value is valid pattern type. valid pattern types must be one of :none, :solid, :mediumGray, :darkGray, :lightGray, :darkHorizontal, :darkVertical, :darkDown, :darkUp, :darkGrid, :darkTrellis, :lightHorizontal, :lightVertical, :lightDown, :lightUp, :lightGrid, -:lightTrellis, :gray125, or :gray0625.</p> +:lightTrellis, :gray125, or :gray0625. +</p> </div> @@ -2013,8 +2191,9 @@ one of :none, :solid, :mediumGray, :darkGray, :lightGray, :darkHorizontal, — - <div class='inline'> -<p>The value validated</p> + <div class='inline'><p> +The value validated +</p> </div> </li> @@ -2036,10 +2215,11 @@ one of :none, :solid, :mediumGray, :darkGray, :lightGray, :darkHorizontal, <td> <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 85</span> -<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id validate_pattern_type'>validate_pattern_type</span><span class='lparen'>(</span><span class='id v'>v</span><span class='rparen'>)</span> - <span class='const'>RestrictionValidator</span><span class='period'>.</span><span class='id validate'>validate</span> <span class='symbol'>:pattern_type</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='symbol'>:none</span><span class='comma'>,</span> <span class='symbol'>:solid</span><span class='comma'>,</span> <span class='symbol'>:mediumGray</span><span class='comma'>,</span> <span class='symbol'>:darkGray</span><span class='comma'>,</span> <span class='symbol'>:lightGray</span><span class='comma'>,</span> <span class='symbol'>:darkHorizontal</span><span class='comma'>,</span> <span class='symbol'>:darkVertical</span><span class='comma'>,</span> <span class='symbol'>:darkDown</span><span class='comma'>,</span> <span class='symbol'>:darkUp</span><span class='comma'>,</span> <span class='symbol'>:darkGrid</span><span class='comma'>,</span> - <span class='symbol'>:darkTrellis</span><span class='comma'>,</span> <span class='symbol'>:lightHorizontal</span><span class='comma'>,</span> <span class='symbol'>:lightVertical</span><span class='comma'>,</span> <span class='symbol'>:lightDown</span><span class='comma'>,</span> <span class='symbol'>:lightUp</span><span class='comma'>,</span> <span class='symbol'>:lightGrid</span><span class='comma'>,</span> <span class='symbol'>:lightTrellis</span><span class='comma'>,</span> <span class='symbol'>:gray125</span><span class='comma'>,</span> <span class='symbol'>:gray0625</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id v'>v</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate_pattern_type identifier id'>validate_pattern_type</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='RestrictionValidator constant id'>RestrictionValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='symbol val'>:pattern_type</span><span class='comma token'>,</span> <span class='lbrack token'>[</span><span class='symbol val'>:none</span><span class='comma token'>,</span> <span class='symbol val'>:solid</span><span class='comma token'>,</span> <span class='symbol val'>:mediumGray</span><span class='comma token'>,</span> <span class='symbol val'>:darkGray</span><span class='comma token'>,</span> <span class='symbol val'>:lightGray</span><span class='comma token'>,</span> <span class='symbol val'>:darkHorizontal</span><span class='comma token'>,</span> <span class='symbol val'>:darkVertical</span><span class='comma token'>,</span> <span class='symbol val'>:darkDown</span><span class='comma token'>,</span> <span class='symbol val'>:darkUp</span><span class='comma token'>,</span> <span class='symbol val'>:darkGrid</span><span class='comma token'>,</span> + <span class='symbol val'>:darkTrellis</span><span class='comma token'>,</span> <span class='symbol val'>:lightHorizontal</span><span class='comma token'>,</span> <span class='symbol val'>:lightVertical</span><span class='comma token'>,</span> <span class='symbol val'>:lightDown</span><span class='comma token'>,</span> <span class='symbol val'>:lightUp</span><span class='comma token'>,</span> <span class='symbol val'>:lightGrid</span><span class='comma token'>,</span> <span class='symbol val'>:lightTrellis</span><span class='comma token'>,</span> <span class='symbol val'>:gray125</span><span class='comma token'>,</span> <span class='symbol val'>:gray0625</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='v identifier id'>v</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -2054,10 +2234,11 @@ one of :none, :solid, :mediumGray, :darkGray, :lightGray, :darkHorizontal, </p><div class="docstring"> <div class="discussion"> - -<p>Requires that the value is a valid relationship_type XML_NS_R, TABLE_R, + <p> +Requires that the value is a valid relationship_type XML_NS_R, TABLE_R, WORKBOOK_R, WORKSHEET_R, APP_R, RELS_R, CORE_R, STYLES_R, CHART_R, -DRAWING_R are allowed</p> +DRAWING_R are allowed +</p> </div> @@ -2076,8 +2257,9 @@ DRAWING_R are allowed</p> — - <div class='inline'> -<p>The value validated</p> + <div class='inline'><p> +The value validated +</p> </div> </li> @@ -2098,9 +2280,10 @@ DRAWING_R are allowed</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 121</span> -<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id validate_relationship_type'>validate_relationship_type</span><span class='lparen'>(</span><span class='id v'>v</span><span class='rparen'>)</span> - <span class='const'>RestrictionValidator</span><span class='period'>.</span><span class='id validate'>validate</span> <span class='symbol'>:relationship_type</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='const'>XML_NS_R</span><span class='comma'>,</span> <span class='const'>TABLE_R</span><span class='comma'>,</span> <span class='const'>WORKBOOK_R</span><span class='comma'>,</span> <span class='const'>WORKSHEET_R</span><span class='comma'>,</span> <span class='const'>APP_R</span><span class='comma'>,</span> <span class='const'>RELS_R</span><span class='comma'>,</span> <span class='const'>CORE_R</span><span class='comma'>,</span> <span class='const'>STYLES_R</span><span class='comma'>,</span> <span class='const'>CHART_R</span><span class='comma'>,</span> <span class='const'>DRAWING_R</span><span class='comma'>,</span> <span class='const'>IMAGE_R</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id v'>v</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate_relationship_type identifier id'>validate_relationship_type</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='RestrictionValidator constant id'>RestrictionValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='symbol val'>:relationship_type</span><span class='comma token'>,</span> <span class='lbrack token'>[</span><span class='XML_NS_R constant id'>XML_NS_R</span><span class='comma token'>,</span> <span class='TABLE_R constant id'>TABLE_R</span><span class='comma token'>,</span> <span class='WORKBOOK_R constant id'>WORKBOOK_R</span><span class='comma token'>,</span> <span class='WORKSHEET_R constant id'>WORKSHEET_R</span><span class='comma token'>,</span> <span class='APP_R constant id'>APP_R</span><span class='comma token'>,</span> <span class='RELS_R constant id'>RELS_R</span><span class='comma token'>,</span> <span class='CORE_R constant id'>CORE_R</span><span class='comma token'>,</span> <span class='STYLES_R constant id'>STYLES_R</span><span class='comma token'>,</span> <span class='CHART_R constant id'>CHART_R</span><span class='comma token'>,</span> <span class='DRAWING_R constant id'>DRAWING_R</span><span class='comma token'>,</span> <span class='IMAGE_R constant id'>IMAGE_R</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='v identifier id'>v</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -2115,8 +2298,9 @@ DRAWING_R are allowed</p> </p><div class="docstring"> <div class="discussion"> - -<p>Requires that the value is a String</p> + <p> +Requires that the value is a String +</p> </div> @@ -2135,8 +2319,9 @@ DRAWING_R are allowed</p> — - <div class='inline'> -<p>The value validated</p> + <div class='inline'><p> +The value validated +</p> </div> </li> @@ -2157,9 +2342,10 @@ DRAWING_R are allowed</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 71</span> -<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id validate_string'>validate_string</span><span class='lparen'>(</span><span class='id v'>v</span><span class='rparen'>)</span> - <span class='const'>DataTypeValidator</span><span class='period'>.</span><span class='id validate'>validate</span> <span class='symbol'>:string</span><span class='comma'>,</span> <span class='const'>String</span><span class='comma'>,</span> <span class='id v'>v</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate_string identifier id'>validate_string</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='DataTypeValidator constant id'>DataTypeValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='symbol val'>:string</span><span class='comma token'>,</span> <span class='String constant id'>String</span><span class='comma token'>,</span> <span class='v identifier id'>v</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -2174,8 +2360,8 @@ DRAWING_R are allowed</p> </p><div class="docstring"> <div class="discussion"> - -<p>Requires that the value is a valid table element type :wholeTable, + <p> +Requires that the value is a valid table element type :wholeTable, :headerRow, :totalRow, :firstColumn, :lastColumn, :firstRowStripe, :secondRowStripe, :firstColumnStripe, :secondColumnStripe, :firstHeaderCell, :lastHeaderCell, :firstTotalCell, :lastTotalCell, @@ -2183,7 +2369,8 @@ DRAWING_R are allowed</p> :firstSubtotalRow, :secondSubtotalRow, :thirdSubtotalRow, :blankRow, :firstColumnSubheading, :secondColumnSubheading, :thirdColumnSubheading, :firstRowSubheading, :secondRowSubheading, :thirdRowSubheading, -:pageFieldLabels, :pageFieldValues are allowed</p> +:pageFieldLabels, :pageFieldValues are allowed +</p> </div> @@ -2202,8 +2389,9 @@ DRAWING_R are allowed</p> — - <div class='inline'> -<p>The value validated</p> + <div class='inline'><p> +The value validated +</p> </div> </li> @@ -2224,9 +2412,10 @@ DRAWING_R are allowed</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 128</span> -<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id validate_table_element_type'>validate_table_element_type</span><span class='lparen'>(</span><span class='id v'>v</span><span class='rparen'>)</span> - <span class='const'>RestrictionValidator</span><span class='period'>.</span><span class='id validate'>validate</span> <span class='symbol'>:table_element_type</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='symbol'>:wholeTable</span><span class='comma'>,</span> <span class='symbol'>:headerRow</span><span class='comma'>,</span> <span class='symbol'>:totalRow</span><span class='comma'>,</span> <span class='symbol'>:firstColumn</span><span class='comma'>,</span> <span class='symbol'>:lastColumn</span><span class='comma'>,</span> <span class='symbol'>:firstRowStripe</span><span class='comma'>,</span> <span class='symbol'>:secondRowStripe</span><span class='comma'>,</span> <span class='symbol'>:firstColumnStripe</span><span class='comma'>,</span> <span class='symbol'>:secondColumnStripe</span><span class='comma'>,</span> <span class='symbol'>:firstHeaderCell</span><span class='comma'>,</span> <span class='symbol'>:lastHeaderCell</span><span class='comma'>,</span> <span class='symbol'>:firstTotalCell</span><span class='comma'>,</span> <span class='symbol'>:lastTotalCell</span><span class='comma'>,</span> <span class='symbol'>:firstSubtotalColumn</span><span class='comma'>,</span> <span class='symbol'>:secondSubtotalColumn</span><span class='comma'>,</span> <span class='symbol'>:thirdSubtotalColumn</span><span class='comma'>,</span> <span class='symbol'>:firstSubtotalRow</span><span class='comma'>,</span> <span class='symbol'>:secondSubtotalRow</span><span class='comma'>,</span> <span class='symbol'>:thirdSubtotalRow</span><span class='comma'>,</span> <span class='symbol'>:blankRow</span><span class='comma'>,</span> <span class='symbol'>:firstColumnSubheading</span><span class='comma'>,</span> <span class='symbol'>:secondColumnSubheading</span><span class='comma'>,</span> <span class='symbol'>:thirdColumnSubheading</span><span class='comma'>,</span> <span class='symbol'>:firstRowSubheading</span><span class='comma'>,</span> <span class='symbol'>:secondRowSubheading</span><span class='comma'>,</span> <span class='symbol'>:thirdRowSubheading</span><span class='comma'>,</span> <span class='symbol'>:pageFieldLabels</span><span class='comma'>,</span> <span class='symbol'>:pageFieldValues</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id v'>v</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate_table_element_type identifier id'>validate_table_element_type</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='RestrictionValidator constant id'>RestrictionValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='symbol val'>:table_element_type</span><span class='comma token'>,</span> <span class='lbrack token'>[</span><span class='symbol val'>:wholeTable</span><span class='comma token'>,</span> <span class='symbol val'>:headerRow</span><span class='comma token'>,</span> <span class='symbol val'>:totalRow</span><span class='comma token'>,</span> <span class='symbol val'>:firstColumn</span><span class='comma token'>,</span> <span class='symbol val'>:lastColumn</span><span class='comma token'>,</span> <span class='symbol val'>:firstRowStripe</span><span class='comma token'>,</span> <span class='symbol val'>:secondRowStripe</span><span class='comma token'>,</span> <span class='symbol val'>:firstColumnStripe</span><span class='comma token'>,</span> <span class='symbol val'>:secondColumnStripe</span><span class='comma token'>,</span> <span class='symbol val'>:firstHeaderCell</span><span class='comma token'>,</span> <span class='symbol val'>:lastHeaderCell</span><span class='comma token'>,</span> <span class='symbol val'>:firstTotalCell</span><span class='comma token'>,</span> <span class='symbol val'>:lastTotalCell</span><span class='comma token'>,</span> <span class='symbol val'>:firstSubtotalColumn</span><span class='comma token'>,</span> <span class='symbol val'>:secondSubtotalColumn</span><span class='comma token'>,</span> <span class='symbol val'>:thirdSubtotalColumn</span><span class='comma token'>,</span> <span class='symbol val'>:firstSubtotalRow</span><span class='comma token'>,</span> <span class='symbol val'>:secondSubtotalRow</span><span class='comma token'>,</span> <span class='symbol val'>:thirdSubtotalRow</span><span class='comma token'>,</span> <span class='symbol val'>:blankRow</span><span class='comma token'>,</span> <span class='symbol val'>:firstColumnSubheading</span><span class='comma token'>,</span> <span class='symbol val'>:secondColumnSubheading</span><span class='comma token'>,</span> <span class='symbol val'>:thirdColumnSubheading</span><span class='comma token'>,</span> <span class='symbol val'>:firstRowSubheading</span><span class='comma token'>,</span> <span class='symbol val'>:secondRowSubheading</span><span class='comma token'>,</span> <span class='symbol val'>:thirdRowSubheading</span><span class='comma token'>,</span> <span class='symbol val'>:pageFieldLabels</span><span class='comma token'>,</span> <span class='symbol val'>:pageFieldValues</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='v identifier id'>v</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -2241,8 +2430,9 @@ DRAWING_R are allowed</p> </p><div class="docstring"> <div class="discussion"> - -<p>Requires that the value is a Fixnum or Integer and is greater or equal to 0</p> + <p> +Requires that the value is a Fixnum or Integer and is greater or equal to 0 +</p> </div> @@ -2261,8 +2451,9 @@ DRAWING_R are allowed</p> — - <div class='inline'> -<p>The value validated</p> + <div class='inline'><p> +The value validated +</p> </div> </li> @@ -2280,8 +2471,9 @@ DRAWING_R are allowed</p> — - <div class='inline'> -<p>true if the data is valid</p> + <div class='inline'><p> +true if the data is valid +</p> </div> </li> @@ -2298,8 +2490,9 @@ DRAWING_R are allowed</p> — - <div class='inline'> -<p>raised if the value is not a Fixnum or Integer value greater or equal to 0</p> + <div class='inline'><p> +raised if the value is not a Fixnum or Integer value greater or equal to 0 +</p> </div> </li> @@ -2319,9 +2512,10 @@ DRAWING_R are allowed</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 51</span> -<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id validate_unsigned_int'>validate_unsigned_int</span><span class='lparen'>(</span><span class='id v'>v</span><span class='rparen'>)</span> - <span class='const'>DataTypeValidator</span><span class='period'>.</span><span class='id validate'>validate</span><span class='lparen'>(</span><span class='symbol'>:unsigned_int</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='const'>Fixnum</span><span class='comma'>,</span> <span class='const'>Integer</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id v'>v</span><span class='comma'>,</span> <span class='id lambda'>lambda</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id arg'>arg</span><span class='op'>|</span> <span class='id arg'>arg</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:>=</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='id arg'>arg</span> <span class='op'>>=</span> <span class='int'>0</span> <span class='rbrace'>}</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate_unsigned_int identifier id'>validate_unsigned_int</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='DataTypeValidator constant id'>DataTypeValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='lparen token'>(</span><span class='symbol val'>:unsigned_int</span><span class='comma token'>,</span> <span class='lbrack token'>[</span><span class='Fixnum constant id'>Fixnum</span><span class='comma token'>,</span> <span class='Integer constant id'>Integer</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='comma token'>,</span> <span class='lambda identifier id'>lambda</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='arg identifier id'>arg</span><span class='bitor op'>|</span> <span class='arg identifier id'>arg</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span><span class='lparen token'>(</span><span class='symbol val'>:>=</span><span class='rparen token'>)</span> <span class='andop op'>&&</span> <span class='arg identifier id'>arg</span> <span class='geq op'>>=</span> <span class='integer val'>0</span> <span class='rbrace token'>}</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -2336,9 +2530,10 @@ DRAWING_R are allowed</p> </p><div class="docstring"> <div class="discussion"> - -<p>Requires that the value is a valid vertical_alignment :top, :center, -:bottom, :justify, :distributed are allowed</p> + <p> +Requires that the value is a valid vertical_alignment :top, :center, +:bottom, :justify, :distributed are allowed +</p> </div> @@ -2357,8 +2552,9 @@ DRAWING_R are allowed</p> — - <div class='inline'> -<p>The value validated</p> + <div class='inline'><p> +The value validated +</p> </div> </li> @@ -2379,9 +2575,10 @@ DRAWING_R are allowed</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 107</span> -<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id validate_vertical_alignment'>validate_vertical_alignment</span><span class='lparen'>(</span><span class='id v'>v</span><span class='rparen'>)</span> - <span class='const'>RestrictionValidator</span><span class='period'>.</span><span class='id validate'>validate</span> <span class='symbol'>:vertical_alignment</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='symbol'>:top</span><span class='comma'>,</span> <span class='symbol'>:center</span><span class='comma'>,</span> <span class='symbol'>:bottom</span><span class='comma'>,</span> <span class='symbol'>:justify</span><span class='comma'>,</span> <span class='symbol'>:distributed</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id v'>v</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate_vertical_alignment identifier id'>validate_vertical_alignment</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='RestrictionValidator constant id'>RestrictionValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='symbol val'>:vertical_alignment</span><span class='comma token'>,</span> <span class='lbrack token'>[</span><span class='symbol val'>:top</span><span class='comma token'>,</span> <span class='symbol val'>:center</span><span class='comma token'>,</span> <span class='symbol val'>:bottom</span><span class='comma token'>,</span> <span class='symbol val'>:justify</span><span class='comma token'>,</span> <span class='symbol val'>:distributed</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='v identifier id'>v</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -2392,9 +2589,9 @@ DRAWING_R are allowed</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:36 2011 by + Generated on Sun Nov 27 18:05:12 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/App.html b/doc/Axlsx/App.html index ca993af0..6d7158b6 100644 --- a/doc/Axlsx/App.html +++ b/doc/Axlsx/App.html @@ -97,19 +97,22 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>Support is not implemented for the following complex types:</p> - -<p>HeadingPairs (VectorVariant), TitlesOfParts (VectorLpstr), HLinks -(VectorVariant), DigSig (DigSigBlob)</p> + <div class='inline'><p> +Support is not implemented for the following complex types: +</p> +<p> +HeadingPairs (VectorVariant), TitlesOfParts (VectorLpstr), HLinks +(VectorVariant), DigSig (DigSigBlob) +</p> </div> </div> - -<p>App represents the app.xml document. The attributes for this object are +<p> +App represents the app.xml document. The attributes for this object are primarily managed by the application the end user uses to edit the document. None of the attributes are required to serialize a valid xlsx -object.</p> +object. +</p> </div> @@ -148,8 +151,9 @@ object.</p> - <span class="summary_desc"><div class='inline'> -<p>The name of the application.</p> + <span class="summary_desc"><div class='inline'><p> +The name of the application. +</p> </div></span> </li> @@ -174,8 +178,9 @@ object.</p> - <span class="summary_desc"><div class='inline'> -<p>The version of the application.</p> + <span class="summary_desc"><div class='inline'><p> +The version of the application. +</p> </div></span> </li> @@ -200,8 +205,9 @@ object.</p> - <span class="summary_desc"><div class='inline'> -<p>The number of characters in the document.</p> + <span class="summary_desc"><div class='inline'><p> +The number of characters in the document. +</p> </div></span> </li> @@ -226,8 +232,9 @@ object.</p> - <span class="summary_desc"><div class='inline'> -<p>The number of characters in the document including spaces.</p> + <span class="summary_desc"><div class='inline'><p> +The number of characters in the document including spaces. +</p> </div></span> </li> @@ -252,8 +259,9 @@ object.</p> - <span class="summary_desc"><div class='inline'> -<p>The name of the company generating the document.</p> + <span class="summary_desc"><div class='inline'><p> +The name of the company generating the document. +</p> </div></span> </li> @@ -278,8 +286,9 @@ object.</p> - <span class="summary_desc"><div class='inline'> -<p>Document security.</p> + <span class="summary_desc"><div class='inline'><p> +Document security. +</p> </div></span> </li> @@ -304,8 +313,9 @@ object.</p> - <span class="summary_desc"><div class='inline'> -<p>The number of hidden slides.</p> + <span class="summary_desc"><div class='inline'><p> +The number of hidden slides. +</p> </div></span> </li> @@ -330,8 +340,9 @@ object.</p> - <span class="summary_desc"><div class='inline'> -<p>The base for hyper links in the document.</p> + <span class="summary_desc"><div class='inline'><p> +The base for hyper links in the document. +</p> </div></span> </li> @@ -356,8 +367,9 @@ object.</p> - <span class="summary_desc"><div class='inline'> -<p>Indicates that the hyper links in the document have been changed.</p> + <span class="summary_desc"><div class='inline'><p> +Indicates that the hyper links in the document have been changed. +</p> </div></span> </li> @@ -382,8 +394,9 @@ object.</p> - <span class="summary_desc"><div class='inline'> -<p>The number of lines in the document.</p> + <span class="summary_desc"><div class='inline'><p> +The number of lines in the document. +</p> </div></span> </li> @@ -408,8 +421,9 @@ object.</p> - <span class="summary_desc"><div class='inline'> -<p>The links in the document are up to date.</p> + <span class="summary_desc"><div class='inline'><p> +The links in the document are up to date. +</p> </div></span> </li> @@ -434,8 +448,9 @@ object.</p> - <span class="summary_desc"><div class='inline'> -<p>The name of the manager for the document.</p> + <span class="summary_desc"><div class='inline'><p> +The name of the manager for the document. +</p> </div></span> </li> @@ -460,8 +475,9 @@ object.</p> - <span class="summary_desc"><div class='inline'> -<p>The total number multimedia clips.</p> + <span class="summary_desc"><div class='inline'><p> +The total number multimedia clips. +</p> </div></span> </li> @@ -486,8 +502,9 @@ object.</p> - <span class="summary_desc"><div class='inline'> -<p>The number of slides that have notes.</p> + <span class="summary_desc"><div class='inline'><p> +The number of slides that have notes. +</p> </div></span> </li> @@ -512,8 +529,9 @@ object.</p> - <span class="summary_desc"><div class='inline'> -<p>The number of pages in the document.</p> + <span class="summary_desc"><div class='inline'><p> +The number of pages in the document. +</p> </div></span> </li> @@ -538,8 +556,9 @@ object.</p> - <span class="summary_desc"><div class='inline'> -<p>The number of paragraphs in the document.</p> + <span class="summary_desc"><div class='inline'><p> +The number of paragraphs in the document. +</p> </div></span> </li> @@ -564,8 +583,9 @@ object.</p> - <span class="summary_desc"><div class='inline'> -<p>The intended format of the presentation.</p> + <span class="summary_desc"><div class='inline'><p> +The intended format of the presentation. +</p> </div></span> </li> @@ -590,8 +610,9 @@ object.</p> - <span class="summary_desc"><div class='inline'> -<p>The display mode for the document thumbnail.</p> + <span class="summary_desc"><div class='inline'><p> +The display mode for the document thumbnail. +</p> </div></span> </li> @@ -616,8 +637,9 @@ object.</p> - <span class="summary_desc"><div class='inline'> -<p>Indicates if the document is shared.</p> + <span class="summary_desc"><div class='inline'><p> +Indicates if the document is shared. +</p> </div></span> </li> @@ -642,8 +664,9 @@ object.</p> - <span class="summary_desc"><div class='inline'> -<p>The number of slides in the document.</p> + <span class="summary_desc"><div class='inline'><p> +The number of slides in the document. +</p> </div></span> </li> @@ -668,8 +691,9 @@ object.</p> - <span class="summary_desc"><div class='inline'> -<p>The name of the document template.</p> + <span class="summary_desc"><div class='inline'><p> +The name of the document template. +</p> </div></span> </li> @@ -694,8 +718,9 @@ object.</p> - <span class="summary_desc"><div class='inline'> -<p>The total amount of time spent editing.</p> + <span class="summary_desc"><div class='inline'><p> +The total amount of time spent editing. +</p> </div></span> </li> @@ -720,8 +745,9 @@ object.</p> - <span class="summary_desc"><div class='inline'> -<p>The number of words in the document.</p> + <span class="summary_desc"><div class='inline'><p> +The number of words in the document. +</p> </div></span> </li> @@ -756,8 +782,9 @@ object.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates an App object.</p> + <span class="summary_desc"><div class='inline'><p> +Creates an App object. +</p> </div></span> </li> @@ -779,8 +806,9 @@ object.</p> - <span class="summary_desc"><div class='inline'> -<p>Generate an app.xml document.</p> + <span class="summary_desc"><div class='inline'><p> +Generate an app.xml document. +</p> </div></span> </li> @@ -805,8 +833,9 @@ object.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The name of the application</p> + <p> +The name of the application +</p> </div> @@ -824,8 +853,9 @@ object.</p> — - <div class='inline'> -<p>The name of the application</p> + <div class='inline'><p> +The name of the application +</p> </div> </li> @@ -845,9 +875,10 @@ object.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 74</span> -<span class='kw'>def</span> <span class='const'>Application</span> - <span class='ivar'>@Application</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='Application constant id'>Application</span> + <span class='@Application ivar id'>@Application</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -865,8 +896,9 @@ object.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The version of the application.</p> + <p> +The version of the application. +</p> </div> @@ -884,8 +916,9 @@ object.</p> — - <div class='inline'> -<p>The version of the application.</p> + <div class='inline'><p> +The version of the application. +</p> </div> </li> @@ -905,9 +938,10 @@ object.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 77</span> -<span class='kw'>def</span> <span class='const'>AppVersion</span> - <span class='ivar'>@AppVersion</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='AppVersion constant id'>AppVersion</span> + <span class='@AppVersion ivar id'>@AppVersion</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -925,8 +959,9 @@ object.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The number of characters in the document.</p> + <p> +The number of characters in the document. +</p> </div> @@ -944,8 +979,9 @@ object.</p> — - <div class='inline'> -<p>The number of characters in the document.</p> + <div class='inline'><p> +The number of characters in the document. +</p> </div> </li> @@ -965,9 +1001,10 @@ object.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 29</span> -<span class='kw'>def</span> <span class='const'>Characters</span> - <span class='ivar'>@Characters</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='Characters constant id'>Characters</span> + <span class='@Characters ivar id'>@Characters</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -985,8 +1022,9 @@ object.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The number of characters in the document including spaces.</p> + <p> +The number of characters in the document including spaces. +</p> </div> @@ -1004,8 +1042,9 @@ object.</p> — - <div class='inline'> -<p>The number of characters in the document including spaces.</p> + <div class='inline'><p> +The number of characters in the document including spaces. +</p> </div> </li> @@ -1025,9 +1064,10 @@ object.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 62</span> -<span class='kw'>def</span> <span class='const'>CharactersWithSpaces</span> - <span class='ivar'>@CharactersWithSpaces</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='CharactersWithSpaces constant id'>CharactersWithSpaces</span> + <span class='@CharactersWithSpaces ivar id'>@CharactersWithSpaces</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1045,8 +1085,9 @@ object.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The name of the company generating the document.</p> + <p> +The name of the company generating the document. +</p> </div> @@ -1064,8 +1105,9 @@ object.</p> — - <div class='inline'> -<p>The name of the company generating the document.</p> + <div class='inline'><p> +The name of the company generating the document. +</p> </div> </li> @@ -1085,9 +1127,10 @@ object.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 20</span> -<span class='kw'>def</span> <span class='const'>Company</span> - <span class='ivar'>@Company</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='Company constant id'>Company</span> + <span class='@Company ivar id'>@Company</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1105,8 +1148,9 @@ object.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Document security</p> + <p> +Document security +</p> </div> @@ -1124,8 +1168,9 @@ object.</p> — - <div class='inline'> -<p>Document security</p> + <div class='inline'><p> +Document security +</p> </div> </li> @@ -1145,9 +1190,10 @@ object.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 80</span> -<span class='kw'>def</span> <span class='const'>DocSecurity</span> - <span class='ivar'>@DocSecurity</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='DocSecurity constant id'>DocSecurity</span> + <span class='@DocSecurity ivar id'>@DocSecurity</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1165,8 +1211,9 @@ object.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The number of hidden slides.</p> + <p> +The number of hidden slides. +</p> </div> @@ -1184,8 +1231,9 @@ object.</p> — - <div class='inline'> -<p>The number of hidden slides.</p> + <div class='inline'><p> +The number of hidden slides. +</p> </div> </li> @@ -1205,9 +1253,10 @@ object.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 50</span> -<span class='kw'>def</span> <span class='const'>HiddenSlides</span> - <span class='ivar'>@HiddenSlides</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='HiddenSlides constant id'>HiddenSlides</span> + <span class='@HiddenSlides ivar id'>@HiddenSlides</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1225,8 +1274,9 @@ object.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The base for hyper links in the document.</p> + <p> +The base for hyper links in the document. +</p> </div> @@ -1244,8 +1294,9 @@ object.</p> — - <div class='inline'> -<p>The base for hyper links in the document.</p> + <div class='inline'><p> +The base for hyper links in the document. +</p> </div> </li> @@ -1265,9 +1316,10 @@ object.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 68</span> -<span class='kw'>def</span> <span class='const'>HyperLinkBase</span> - <span class='ivar'>@HyperLinkBase</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='HyperLinkBase constant id'>HyperLinkBase</span> + <span class='@HyperLinkBase ivar id'>@HyperLinkBase</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1285,8 +1337,9 @@ object.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Indicates that the hyper links in the document have been changed.</p> + <p> +Indicates that the hyper links in the document have been changed. +</p> </div> @@ -1304,8 +1357,9 @@ object.</p> — - <div class='inline'> -<p>Indicates that the hyper links in the document have been changed.</p> + <div class='inline'><p> +Indicates that the hyper links in the document have been changed. +</p> </div> </li> @@ -1325,9 +1379,10 @@ object.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 71</span> -<span class='kw'>def</span> <span class='const'>HyperlinksChanged</span> - <span class='ivar'>@HyperlinksChanged</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='HyperlinksChanged constant id'>HyperlinksChanged</span> + <span class='@HyperlinksChanged ivar id'>@HyperlinksChanged</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1345,8 +1400,9 @@ object.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The number of lines in the document.</p> + <p> +The number of lines in the document. +</p> </div> @@ -1364,8 +1420,9 @@ object.</p> — - <div class='inline'> -<p>The number of lines in the document.</p> + <div class='inline'><p> +The number of lines in the document. +</p> </div> </li> @@ -1385,9 +1442,10 @@ object.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 35</span> -<span class='kw'>def</span> <span class='const'>Lines</span> - <span class='ivar'>@Lines</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='Lines constant id'>Lines</span> + <span class='@Lines ivar id'>@Lines</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1405,8 +1463,9 @@ object.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The links in the document are up to date.</p> + <p> +The links in the document are up to date. +</p> </div> @@ -1424,8 +1483,9 @@ object.</p> — - <div class='inline'> -<p>The links in the document are up to date.</p> + <div class='inline'><p> +The links in the document are up to date. +</p> </div> </li> @@ -1445,9 +1505,10 @@ object.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 59</span> -<span class='kw'>def</span> <span class='const'>LinksUpToDate</span> - <span class='ivar'>@LinksUpToDate</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='LinksUpToDate constant id'>LinksUpToDate</span> + <span class='@LinksUpToDate ivar id'>@LinksUpToDate</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1465,8 +1526,9 @@ object.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The name of the manager for the document.</p> + <p> +The name of the manager for the document. +</p> </div> @@ -1484,8 +1546,9 @@ object.</p> — - <div class='inline'> -<p>The name of the manager for the document.</p> + <div class='inline'><p> +The name of the manager for the document. +</p> </div> </li> @@ -1505,9 +1568,10 @@ object.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 17</span> -<span class='kw'>def</span> <span class='const'>Manager</span> - <span class='ivar'>@Manager</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='Manager constant id'>Manager</span> + <span class='@Manager ivar id'>@Manager</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1525,8 +1589,9 @@ object.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The total number multimedia clips</p> + <p> +The total number multimedia clips +</p> </div> @@ -1544,8 +1609,9 @@ object.</p> — - <div class='inline'> -<p>The total number multimedia clips</p> + <div class='inline'><p> +The total number multimedia clips +</p> </div> </li> @@ -1565,9 +1631,10 @@ object.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 53</span> -<span class='kw'>def</span> <span class='const'>MMClips</span> - <span class='ivar'>@MMClips</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='MMClips constant id'>MMClips</span> + <span class='@MMClips ivar id'>@MMClips</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1585,8 +1652,9 @@ object.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The number of slides that have notes.</p> + <p> +The number of slides that have notes. +</p> </div> @@ -1604,8 +1672,9 @@ object.</p> — - <div class='inline'> -<p>The number of slides that have notes.</p> + <div class='inline'><p> +The number of slides that have notes. +</p> </div> </li> @@ -1625,9 +1694,10 @@ object.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 44</span> -<span class='kw'>def</span> <span class='const'>Notes</span> - <span class='ivar'>@Notes</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='Notes constant id'>Notes</span> + <span class='@Notes ivar id'>@Notes</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1645,8 +1715,9 @@ object.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The number of pages in the document.</p> + <p> +The number of pages in the document. +</p> </div> @@ -1664,8 +1735,9 @@ object.</p> — - <div class='inline'> -<p>The number of pages in the document.</p> + <div class='inline'><p> +The number of pages in the document. +</p> </div> </li> @@ -1685,9 +1757,10 @@ object.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 23</span> -<span class='kw'>def</span> <span class='const'>Pages</span> - <span class='ivar'>@Pages</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='Pages constant id'>Pages</span> + <span class='@Pages ivar id'>@Pages</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1705,8 +1778,9 @@ object.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The number of paragraphs in the document</p> + <p> +The number of paragraphs in the document +</p> </div> @@ -1724,8 +1798,9 @@ object.</p> — - <div class='inline'> -<p>The number of paragraphs in the document</p> + <div class='inline'><p> +The number of paragraphs in the document +</p> </div> </li> @@ -1745,9 +1820,10 @@ object.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 38</span> -<span class='kw'>def</span> <span class='const'>Paragraphs</span> - <span class='ivar'>@Paragraphs</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='Paragraphs constant id'>Paragraphs</span> + <span class='@Paragraphs ivar id'>@Paragraphs</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1765,8 +1841,9 @@ object.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The intended format of the presentation.</p> + <p> +The intended format of the presentation. +</p> </div> @@ -1784,8 +1861,9 @@ object.</p> — - <div class='inline'> -<p>The intended format of the presentation.</p> + <div class='inline'><p> +The intended format of the presentation. +</p> </div> </li> @@ -1805,9 +1883,10 @@ object.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 32</span> -<span class='kw'>def</span> <span class='const'>PresentationFormat</span> - <span class='ivar'>@PresentationFormat</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='PresentationFormat constant id'>PresentationFormat</span> + <span class='@PresentationFormat ivar id'>@PresentationFormat</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1825,8 +1904,9 @@ object.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The display mode for the document thumbnail.</p> + <p> +The display mode for the document thumbnail. +</p> </div> @@ -1844,8 +1924,9 @@ object.</p> — - <div class='inline'> -<p>The display mode for the document thumbnail.</p> + <div class='inline'><p> +The display mode for the document thumbnail. +</p> </div> </li> @@ -1865,9 +1946,10 @@ object.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 56</span> -<span class='kw'>def</span> <span class='const'>ScaleCrop</span> - <span class='ivar'>@ScaleCrop</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='ScaleCrop constant id'>ScaleCrop</span> + <span class='@ScaleCrop ivar id'>@ScaleCrop</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1885,8 +1967,9 @@ object.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Indicates if the document is shared.</p> + <p> +Indicates if the document is shared. +</p> </div> @@ -1904,8 +1987,9 @@ object.</p> — - <div class='inline'> -<p>Indicates if the document is shared.</p> + <div class='inline'><p> +Indicates if the document is shared. +</p> </div> </li> @@ -1925,9 +2009,10 @@ object.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 65</span> -<span class='kw'>def</span> <span class='const'>ShareDoc</span> - <span class='ivar'>@ShareDoc</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='ShareDoc constant id'>ShareDoc</span> + <span class='@ShareDoc ivar id'>@ShareDoc</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1945,8 +2030,9 @@ object.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The number of slides in the document.</p> + <p> +The number of slides in the document. +</p> </div> @@ -1964,8 +2050,9 @@ object.</p> — - <div class='inline'> -<p>The number of slides in the document.</p> + <div class='inline'><p> +The number of slides in the document. +</p> </div> </li> @@ -1985,9 +2072,10 @@ object.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 41</span> -<span class='kw'>def</span> <span class='const'>Slides</span> - <span class='ivar'>@Slides</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='Slides constant id'>Slides</span> + <span class='@Slides ivar id'>@Slides</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -2005,8 +2093,9 @@ object.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The name of the document template.</p> + <p> +The name of the document template. +</p> </div> @@ -2024,8 +2113,9 @@ object.</p> — - <div class='inline'> -<p>The name of the document template.</p> + <div class='inline'><p> +The name of the document template. +</p> </div> </li> @@ -2045,9 +2135,10 @@ object.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 14</span> -<span class='kw'>def</span> <span class='const'>Template</span> - <span class='ivar'>@Template</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='Template constant id'>Template</span> + <span class='@Template ivar id'>@Template</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -2065,8 +2156,9 @@ object.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The total amount of time spent editing.</p> + <p> +The total amount of time spent editing. +</p> </div> @@ -2084,8 +2176,9 @@ object.</p> — - <div class='inline'> -<p>The total amount of time spent editing.</p> + <div class='inline'><p> +The total amount of time spent editing. +</p> </div> </li> @@ -2105,9 +2198,10 @@ object.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 47</span> -<span class='kw'>def</span> <span class='const'>TotalTime</span> - <span class='ivar'>@TotalTime</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='TotalTime constant id'>TotalTime</span> + <span class='@TotalTime ivar id'>@TotalTime</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -2125,8 +2219,9 @@ object.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The number of words in the document.</p> + <p> +The number of words in the document. +</p> </div> @@ -2144,8 +2239,9 @@ object.</p> — - <div class='inline'> -<p>The number of words in the document.</p> + <div class='inline'><p> +The number of words in the document. +</p> </div> </li> @@ -2165,9 +2261,10 @@ object.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 26</span> -<span class='kw'>def</span> <span class='const'>Words</span> - <span class='ivar'>@Words</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='Words constant id'>Words</span> + <span class='@Words ivar id'>@Words</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -2189,8 +2286,9 @@ object.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates an App object</p> + <p> +Creates an App object +</p> </div> @@ -2211,8 +2309,9 @@ object.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -2442,11 +2541,12 @@ object.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 105</span> -<span class='kw'>def</span> <span class='id initalize'>initalize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> - <span class='kw'>end</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initalize identifier id'>initalize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -2461,8 +2561,9 @@ object.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Generate an app.xml document</p> + <p> +Generate an app.xml document +</p> </div> @@ -2480,8 +2581,9 @@ object.</p> — - <div class='inline'> -<p>The document as a string</p> + <div class='inline'><p> +The document as a string +</p> </div> </li> @@ -2508,16 +2610,17 @@ object.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 167</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='rparen'>)</span> - <span class='id builder'>builder</span> <span class='op'>=</span> <span class='const'>Nokogiri</span><span class='op'>::</span><span class='const'>XML</span><span class='op'>::</span><span class='const'>Builder</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='symbol'>:encoding</span> <span class='op'>=></span> <span class='const'>ENCODING</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id xml'>xml</span><span class='op'>|</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='symbol'>:Properties</span><span class='comma'>,</span> <span class='symbol'>:xmlns</span> <span class='op'>=></span> <span class='const'>APP_NS</span><span class='comma'>,</span> <span class='symbol'>:xmlns:vt</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='const'>APP_NS_VT</span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id instance_values'>instance_values</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id name'>name</span><span class='comma'>,</span> <span class='id value'>value</span><span class='op'>|</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ap:</span><span class='embexpr_beg'>#{</span><span class='id name'>name</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id value'>value</span><span class='rparen'>)</span> - <span class='kw'>end</span> - <span class='rbrace'>}</span> - <span class='kw'>end</span> - <span class='id builder'>builder</span><span class='period'>.</span><span class='id to_xml'>to_xml</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='rparen token'>)</span> + <span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='symbol val'>:Properties</span><span class='comma token'>,</span> <span class='symbol val'>:xmlns</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='APP_NS constant id'>APP_NS</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:vt'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='APP_NS_VT constant id'>APP_NS_VT</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='value identifier id'>value</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"ap:#{name}"</span><span class='comma token'>,</span> <span class='value identifier id'>value</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -2528,9 +2631,9 @@ object.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:36 2011 by + Generated on Sun Nov 27 18:05:21 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/Ar.html b/doc/Axlsx/Ar.html new file mode 100644 index 00000000..cf57963c --- /dev/null +++ b/doc/Axlsx/Ar.html @@ -0,0 +1,106 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<title> + Module: Axlsx::Ar + + — AXLSX + +</title> + + <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" /> + + <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" /> + +<script type="text/javascript" charset="utf-8"> + relpath = '..'; + if (relpath != '') relpath += '/'; +</script> + + <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> + + <script type="text/javascript" charset="utf-8" src="../js/app.js"></script> + + + </head> + <body> + <script type="text/javascript" charset="utf-8"> + if (window.top.frames.main) document.body.className = 'frames'; + </script> + + <div id="header"> + <div id="menu"> + + <a href="../_index.html">Index (A)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">Ar</span> + + + <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div> +</div> + + <div id="search"> + + <a id="class_list_link" href="#">Class List</a> + + <a id="method_list_link" href="#">Method List</a> + + <a id="file_list_link" href="#">File List</a> + +</div> + <div class="clear"></div> + </div> + + <iframe id="search_frame"></iframe> + + <div id="content"><h1>Module: Axlsx::Ar + + + +</h1> + +<dl class="box"> + + + + + + + + + <dt class="r1 last">Defined in:</dt> + <dd class="r1 last">lib/axlsx/ar.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Defined Under Namespace</h2> +<p class="children"> + + + <strong class="modules">Modules:</strong> <span class='object_link'><a href="Ar/ClassMethods.html" title="Axlsx::Ar::ClassMethods (module)">ClassMethods</a></span>, <span class='object_link'><a href="Ar/InstanceMethods.html" title="Axlsx::Ar::InstanceMethods (module)">InstanceMethods</a></span>, <span class='object_link'><a href="Ar/SingletonMethods.html" title="Axlsx::Ar::SingletonMethods (module)">SingletonMethods</a></span> + + + + +</p> + + + + + + + +</div> + + <div id="footer"> + Generated on Sun Nov 27 18:05:05 2011 by + <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> + 0.7.3 (ruby-1.8.7). +</div> + + </body> +</html>
\ No newline at end of file diff --git a/doc/Axlsx/Ar/ClassMethods.html b/doc/Axlsx/Ar/ClassMethods.html new file mode 100644 index 00000000..5d3fff33 --- /dev/null +++ b/doc/Axlsx/Ar/ClassMethods.html @@ -0,0 +1,180 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<title> + Module: Axlsx::Ar::ClassMethods + + — AXLSX + +</title> + + <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" /> + + <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" /> + +<script type="text/javascript" charset="utf-8"> + relpath = '../..'; + if (relpath != '') relpath += '/'; +</script> + + <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> + + <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script> + + + </head> + <body> + <script type="text/javascript" charset="utf-8"> + if (window.top.frames.main) document.body.className = 'frames'; + </script> + + <div id="header"> + <div id="menu"> + + <a href="../../_index.html">Index (C)</a> » + <span class='title'><span class='object_link'><a href="../../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> » <span class='title'><span class='object_link'><a href="../Ar.html" title="Axlsx::Ar (module)">Ar</a></span></span> + » + <span class="title">ClassMethods</span> + + + <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div> +</div> + + <div id="search"> + + <a id="class_list_link" href="#">Class List</a> + + <a id="method_list_link" href="#">Method List</a> + + <a id="file_list_link" href="#">File List</a> + +</div> + <div class="clear"></div> + </div> + + <iframe id="search_frame"></iframe> + + <div id="content"><h1>Module: Axlsx::Ar::ClassMethods + + + +</h1> + +<dl class="box"> + + + + + + + + + <dt class="r1 last">Defined in:</dt> + <dd class="r1 last">lib/axlsx/ar.rb</dd> + +</dl> +<div class="clear"></div> + + + + + + + + <h2> + Instance Method Summary + <small>(<a href="#" class="summary_toggle">collapse</a>)</small> + </h2> + + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> + + <a href="#acts_as_axlsx-instance_method" title="#acts_as_axlsx (instance method)">- (Object) <strong>acts_as_axlsx</strong>(options = {}) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +we should do what ruport did and use only, exclude and methods hashes. +</p> +</div></span> + +</li> + + + </ul> + + + + + <div id="instance_method_details" class="method_details_list"> + <h2>Instance Method Details</h2> + + + <div class="method_details first"> + <p class="signature first" id="acts_as_axlsx-instance_method"> + + - (<tt>Object</tt>) <strong>acts_as_axlsx</strong>(options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +we should do what ruport did and use only, exclude and methods hashes +</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +14 +15 +16 +17</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/ar.rb', line 14</span> + +<span class='def def kw'>def</span> <span class='acts_as_axlsx identifier id'>acts_as_axlsx</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='include identifier id'>include</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Ar constant id'>Ar</span><span class='colon2 op'>::</span><span class='InstanceMethods constant id'>InstanceMethods</span> + <span class='extend identifier id'>extend</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Ar constant id'>Ar</span><span class='colon2 op'>::</span><span class='SingletonMethods constant id'>SingletonMethods</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 27 18:05:04 2011 by + <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> + 0.7.3 (ruby-1.8.7). +</div> + + </body> +</html>
\ No newline at end of file diff --git a/doc/Axlsx/Ar/InstanceMethods.html b/doc/Axlsx/Ar/InstanceMethods.html new file mode 100644 index 00000000..7734dde4 --- /dev/null +++ b/doc/Axlsx/Ar/InstanceMethods.html @@ -0,0 +1,96 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<title> + Module: Axlsx::Ar::InstanceMethods + + — AXLSX + +</title> + + <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" /> + + <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" /> + +<script type="text/javascript" charset="utf-8"> + relpath = '../..'; + if (relpath != '') relpath += '/'; +</script> + + <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> + + <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script> + + + </head> + <body> + <script type="text/javascript" charset="utf-8"> + if (window.top.frames.main) document.body.className = 'frames'; + </script> + + <div id="header"> + <div id="menu"> + + <a href="../../_index.html">Index (I)</a> » + <span class='title'><span class='object_link'><a href="../../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> » <span class='title'><span class='object_link'><a href="../Ar.html" title="Axlsx::Ar (module)">Ar</a></span></span> + » + <span class="title">InstanceMethods</span> + + + <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div> +</div> + + <div id="search"> + + <a id="class_list_link" href="#">Class List</a> + + <a id="method_list_link" href="#">Method List</a> + + <a id="file_list_link" href="#">File List</a> + +</div> + <div class="clear"></div> + </div> + + <iframe id="search_frame"></iframe> + + <div id="content"><h1>Module: Axlsx::Ar::InstanceMethods + + + +</h1> + +<dl class="box"> + + + + + + + + + <dt class="r1 last">Defined in:</dt> + <dd class="r1 last">lib/axlsx/ar.rb</dd> + +</dl> +<div class="clear"></div> + + + + + + + + +</div> + + <div id="footer"> + Generated on Sun Nov 27 18:05:04 2011 by + <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> + 0.7.3 (ruby-1.8.7). +</div> + + </body> +</html>
\ No newline at end of file diff --git a/doc/Axlsx/Ar/SingletonMethods.html b/doc/Axlsx/Ar/SingletonMethods.html new file mode 100644 index 00000000..9781895c --- /dev/null +++ b/doc/Axlsx/Ar/SingletonMethods.html @@ -0,0 +1,199 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<title> + Module: Axlsx::Ar::SingletonMethods + + — AXLSX + +</title> + + <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" /> + + <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" /> + +<script type="text/javascript" charset="utf-8"> + relpath = '../..'; + if (relpath != '') relpath += '/'; +</script> + + <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> + + <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script> + + + </head> + <body> + <script type="text/javascript" charset="utf-8"> + if (window.top.frames.main) document.body.className = 'frames'; + </script> + + <div id="header"> + <div id="menu"> + + <a href="../../_index.html">Index (S)</a> » + <span class='title'><span class='object_link'><a href="../../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> » <span class='title'><span class='object_link'><a href="../Ar.html" title="Axlsx::Ar (module)">Ar</a></span></span> + » + <span class="title">SingletonMethods</span> + + + <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div> +</div> + + <div id="search"> + + <a id="class_list_link" href="#">Class List</a> + + <a id="method_list_link" href="#">Method List</a> + + <a id="file_list_link" href="#">File List</a> + +</div> + <div class="clear"></div> + </div> + + <iframe id="search_frame"></iframe> + + <div id="content"><h1>Module: Axlsx::Ar::SingletonMethods + + + +</h1> + +<dl class="box"> + + + + + + + + + <dt class="r1 last">Defined in:</dt> + <dd class="r1 last">lib/axlsx/ar.rb</dd> + +</dl> +<div class="clear"></div> + + + + + + + + <h2> + Instance Method Summary + <small>(<a href="#" class="summary_toggle">collapse</a>)</small> + </h2> + + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> + + <a href="#to_xlsx-instance_method" title="#to_xlsx (instance method)">- (Object) <strong>to_xlsx</strong>(number = :all, options = {}) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'></div></span> + +</li> + + + </ul> + + + + + <div id="instance_method_details" class="method_details_list"> + <h2>Instance Method Details</h2> + + + <div class="method_details first"> + <p class="signature first" id="to_xlsx-instance_method"> + + - (<tt>Object</tt>) <strong>to_xlsx</strong>(number = :all, options = {}) + + + +</p><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/ar.rb', line 22</span> + +<span class='def def kw'>def</span> <span class='to_xlsx identifier id'>to_xlsx</span><span class='lparen token'>(</span><span class='number identifier id'>number</span> <span class='assign token'>=</span> <span class='symbol val'>:all</span><span class='comma token'>,</span> <span class='options identifier id'>options</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='row_style identifier id'>row_style</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='delete identifier id'>delete</span><span class='lparen token'>(</span><span class='symbol val'>:style</span><span class='rparen token'>)</span> + <span class='header_style identifier id'>header_style</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='delete identifier id'>delete</span><span class='lparen token'>(</span><span class='symbol val'>:header_style</span><span class='rparen token'>)</span> <span class='orop op'>||</span> <span class='row_style identifier id'>row_style</span> + <span class='types identifier id'>types</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='delete identifier id'>delete</span><span class='lparen token'>(</span><span class='symbol val'>:types</span><span class='rparen token'>)</span> + + <span class='data identifier id'>data</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='mult op'>*</span><span class='find identifier id'>find</span><span class='lparen token'>(</span><span class='number identifier id'>number</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span><span class='rbrack token'>]</span> + <span class='data identifier id'>data</span><span class='dot token'>.</span><span class='compact! fid id'>compact!</span> + <span class='data identifier id'>data</span><span class='dot token'>.</span><span class='flatten! fid id'>flatten!</span> + <span class='columns identifier id'>columns</span> <span class='assign token'>=</span> <span class='data identifier id'>data</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='attributes identifier id'>attributes</span><span class='dot token'>.</span><span class='keys identifier id'>keys</span> + <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='row_style identifier id'>row_style</span> <span class='assign token'>=</span> <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span><span class='lparen token'>(</span><span class='row_style identifier id'>row_style</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='row_style identifier id'>row_style</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='header_style identifier id'>header_style</span> <span class='assign token'>=</span> <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span><span class='lparen token'>(</span><span class='header_style identifier id'>header_style</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='header_style identifier id'>header_style</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span><span class='lparen token'>(</span><span class='symbol val'>:name=</span><span class='gt op'>></span><span class='table_name identifier id'>table_name</span><span class='dot token'>.</span><span class='humanize identifier id'>humanize</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='columns identifier id'>columns</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='header_style identifier id'>header_style</span> + <span class='data identifier id'>data</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='r identifier id'>r</span><span class='bitor op'>|</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='r identifier id'>r</span><span class='dot token'>.</span><span class='attributes identifier id'>attributes</span><span class='dot token'>.</span><span class='values identifier id'>values</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='row_style identifier id'>row_style</span><span class='comma token'>,</span> <span class='symbol val'>:types=</span><span class='gt op'>></span><span class='types identifier id'>types</span> + <span class='end end kw'>end</span> + <span class='end end kw'>end</span> + <span class='p identifier id'>p</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 27 18:05:16 2011 by + <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> + 0.7.3 (ruby-1.8.7). +</div> + + </body> +</html>
\ No newline at end of file diff --git a/doc/Axlsx/Axis.html b/doc/Axlsx/Axis.html index b3e3b295..7e86aa9a 100644 --- a/doc/Axlsx/Axis.html +++ b/doc/Axlsx/Axis.html @@ -94,8 +94,9 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>the access class defines common properties and values for a chart axis.</p> + <p> +the access class defines common properties and values for a chart axis. +</p> </div> @@ -131,8 +132,9 @@ - <span class="summary_desc"><div class='inline'> -<p>the id of the axis.</p> + <span class="summary_desc"><div class='inline'><p> +the id of the axis. +</p> </div></span> </li> @@ -157,8 +159,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The position of the axis must be one of [:l, :r, :t, :b].</p> + <span class="summary_desc"><div class='inline'><p> +The position of the axis must be one of [:l, :r, :t, :b]. +</p> </div></span> </li> @@ -183,8 +186,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The perpendicular axis.</p> + <span class="summary_desc"><div class='inline'><p> +The perpendicular axis. +</p> </div></span> </li> @@ -209,9 +213,10 @@ - <span class="summary_desc"><div class='inline'> -<p>specifies how the perpendicular axis is crossed must be one of [:autoZero, -:min, :max].</p> + <span class="summary_desc"><div class='inline'><p> +specifies how the perpendicular axis is crossed must be one of [:autoZero, +:min, :max]. +</p> </div></span> </li> @@ -236,8 +241,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The number format format code for this axis default :General.</p> + <span class="summary_desc"><div class='inline'><p> +The number format format code for this axis default :General. +</p> </div></span> </li> @@ -262,8 +268,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The scaling of the axis.</p> + <span class="summary_desc"><div class='inline'><p> +The scaling of the axis. +</p> </div></span> </li> @@ -288,8 +295,9 @@ - <span class="summary_desc"><div class='inline'> -<p>the position of the tick labels must be one of [:nextTo, :high, :low].</p> + <span class="summary_desc"><div class='inline'><p> +the position of the tick labels must be one of [:nextTo, :high, :low]. +</p> </div></span> </li> @@ -326,8 +334,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Creates an Axis object.</p> + <span class="summary_desc"><div class='inline'><p> +Creates an Axis object. +</p> </div></span> </li> @@ -349,8 +358,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Serializes the common axis.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the common axis. +</p> </div></span> </li> @@ -371,8 +381,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Creates an Axis object</p> + <p> +Creates an Axis object +</p> </div> @@ -391,8 +402,9 @@ — - <div class='inline'> -<p>the id of this axis</p> + <div class='inline'><p> +the id of this axis +</p> </div> </li> @@ -407,8 +419,9 @@ — - <div class='inline'> -<p>the id of the perpendicular axis</p> + <div class='inline'><p> +the id of the perpendicular axis +</p> </div> </li> @@ -425,8 +438,9 @@ — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -484,8 +498,9 @@ — - <div class='inline'> -<p>If axId or crossAx are not unsigned integers</p> + <div class='inline'><p> +If axId or crossAx are not unsigned integers +</p> </div> </li> @@ -517,21 +532,22 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 45</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id axId'>axId</span><span class='comma'>,</span> <span class='id crossAx'>crossAx</span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='const'>Axlsx</span><span class='op'>::</span><span class='id validate_unsigned_int'>validate_unsigned_int</span><span class='lparen'>(</span><span class='id axId'>axId</span><span class='rparen'>)</span> - <span class='const'>Axlsx</span><span class='op'>::</span><span class='id validate_unsigned_int'>validate_unsigned_int</span><span class='lparen'>(</span><span class='id crossAx'>crossAx</span><span class='rparen'>)</span> - <span class='ivar'>@axId</span> <span class='op'>=</span> <span class='id axId'>axId</span> - <span class='ivar'>@crossAx</span> <span class='op'>=</span> <span class='id crossAx'>crossAx</span> - <span class='ivar'>@format_code</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>General</span><span class='tstring_end'>"</span></span> - <span class='ivar'>@scaling</span> <span class='op'>=</span> <span class='const'>Scaling</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='symbol'>:orientation</span><span class='op'>=></span><span class='symbol'>:minMax</span><span class='rparen'>)</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id axPos'>axPos</span> <span class='op'>=</span> <span class='symbol'>:l</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id tickLblPos'>tickLblPos</span> <span class='op'>=</span> <span class='symbol'>:nextTo</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id format_code'>format_code</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>General</span><span class='tstring_end'>"</span></span> - <span class='kw'>self</span><span class='period'>.</span><span class='id crosses'>crosses</span> <span class='op'>=</span> <span class='symbol'>:autoZero</span> - <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span> - <span class='kw'>end</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='axId identifier id'>axId</span><span class='comma token'>,</span> <span class='crossAx identifier id'>crossAx</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='validate_unsigned_int identifier id'>validate_unsigned_int</span><span class='lparen token'>(</span><span class='axId identifier id'>axId</span><span class='rparen token'>)</span> + <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='validate_unsigned_int identifier id'>validate_unsigned_int</span><span class='lparen token'>(</span><span class='crossAx identifier id'>crossAx</span><span class='rparen token'>)</span> + <span class='@axId ivar id'>@axId</span> <span class='assign token'>=</span> <span class='axId identifier id'>axId</span> + <span class='@crossAx ivar id'>@crossAx</span> <span class='assign token'>=</span> <span class='crossAx identifier id'>crossAx</span> + <span class='@format_code ivar id'>@format_code</span> <span class='assign token'>=</span> <span class='string val'>"General"</span> + <span class='@scaling ivar id'>@scaling</span> <span class='assign token'>=</span> <span class='Scaling constant id'>Scaling</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:orientation=</span><span class='gt op'>></span><span class='symbol val'>:minMax</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='axPos identifier id'>axPos</span> <span class='assign token'>=</span> <span class='symbol val'>:l</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='tickLblPos identifier id'>tickLblPos</span> <span class='assign token'>=</span> <span class='symbol val'>:nextTo</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='format_code identifier id'>format_code</span> <span class='assign token'>=</span> <span class='string val'>"General"</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='crosses identifier id'>crosses</span> <span class='assign token'>=</span> <span class='symbol val'>:autoZero</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -554,8 +570,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>the id of the axis.</p> + <p> +the id of the axis. +</p> </div> @@ -589,9 +606,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 7</span> -<span class='kw'>def</span> <span class='id axId'>axId</span> - <span class='ivar'>@axId</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='axId identifier id'>axId</span> + <span class='@axId ivar id'>@axId</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -609,8 +627,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>The position of the axis must be one of [:l, :r, :t, :b]</p> + <p> +The position of the axis must be one of [:l, :r, :t, :b] +</p> </div> @@ -644,9 +663,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 21</span> -<span class='kw'>def</span> <span class='id axPos'>axPos</span> - <span class='ivar'>@axPos</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='axPos identifier id'>axPos</span> + <span class='@axPos ivar id'>@axPos</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -664,8 +684,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>The perpendicular axis</p> + <p> +The perpendicular axis +</p> </div> @@ -699,9 +720,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 11</span> -<span class='kw'>def</span> <span class='id crossAx'>crossAx</span> - <span class='ivar'>@crossAx</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='crossAx identifier id'>crossAx</span> + <span class='@crossAx ivar id'>@crossAx</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -719,9 +741,10 @@ </p><div class="docstring"> <div class="discussion"> - -<p>specifies how the perpendicular axis is crossed must be one of [:autoZero, -:min, :max]</p> + <p> +specifies how the perpendicular axis is crossed must be one of [:autoZero, +:min, :max] +</p> </div> @@ -755,9 +778,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 36</span> -<span class='kw'>def</span> <span class='id crosses'>crosses</span> - <span class='ivar'>@crosses</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='crosses identifier id'>crosses</span> + <span class='@crosses ivar id'>@crosses</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -775,8 +799,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>The number format format code for this axis default :General</p> + <p> +The number format format code for this axis default :General +</p> </div> @@ -810,9 +835,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 31</span> -<span class='kw'>def</span> <span class='id format_code'>format_code</span> - <span class='ivar'>@format_code</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='format_code identifier id'>format_code</span> + <span class='@format_code ivar id'>@format_code</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -830,8 +856,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>The scaling of the axis</p> + <p> +The scaling of the axis +</p> </div> @@ -872,9 +899,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 16</span> -<span class='kw'>def</span> <span class='id scaling'>scaling</span> - <span class='ivar'>@scaling</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='scaling identifier id'>scaling</span> + <span class='@scaling ivar id'>@scaling</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -892,8 +920,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>the position of the tick labels must be one of [:nextTo, :high, :low]</p> + <p> +the position of the tick labels must be one of [:nextTo, :high, :low] +</p> </div> @@ -927,9 +956,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 26</span> -<span class='kw'>def</span> <span class='id tickLblPos'>tickLblPos</span> - <span class='ivar'>@tickLblPos</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='tickLblPos identifier id'>tickLblPos</span> + <span class='@tickLblPos ivar id'>@tickLblPos</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -951,8 +981,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the common axis</p> + <p> +Serializes the common axis +</p> </div> @@ -971,8 +1002,9 @@ — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -1013,16 +1045,17 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 79</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:axId</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@axId</span><span class='rparen'>)</span> - <span class='ivar'>@scaling</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:axPos</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@axPos</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:majorGridlines</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:numFmt</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:formatCode</span> <span class='op'>=></span> <span class='ivar'>@format_code</span><span class='comma'>,</span> <span class='symbol'>:sourceLinked</span><span class='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:tickLblPos</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@tickLblPos</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:crossAx</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@crossAx</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:crosses</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@crosses</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:axId'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@axId ivar id'>@axId</span><span class='rparen token'>)</span> + <span class='@scaling ivar id'>@scaling</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:axPos'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@axPos ivar id'>@axPos</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:majorGridlines'</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:numFmt'</span><span class='comma token'>,</span> <span class='symbol val'>:formatCode</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='@format_code ivar id'>@format_code</span><span class='comma token'>,</span> <span class='symbol val'>:sourceLinked=</span><span class='gt op'>></span><span class='string val'>"1"</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:tickLblPos'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@tickLblPos ivar id'>@tickLblPos</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:crossAx'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@crossAx ivar id'>@crossAx</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:crosses'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@crosses ivar id'>@crosses</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1033,9 +1066,9 @@ </div> <div id="footer"> - Generated on Sat Nov 26 13:16:36 2011 by + Generated on Sun Nov 27 18:05:05 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/Bar3DChart.html b/doc/Axlsx/Bar3DChart.html index 3ad3b313..2fb7ad0b 100644 --- a/doc/Axlsx/Bar3DChart.html +++ b/doc/Axlsx/Bar3DChart.html @@ -96,9 +96,10 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>The Bar3DChart is a three dimentional barchart (who would have guessed?) -that you can add to your worksheet.</p> + <p> +The Bar3DChart is a three dimentional barchart (who would have guessed?) +that you can add to your worksheet. +</p> </div> @@ -127,8 +128,9 @@ that you can add to your worksheet.</p> <dt id="GAP_AMOUNT_PERCENT-constant" class="">GAP_AMOUNT_PERCENT = <div class="docstring"> <div class="discussion"> - -<p>validation regex for gap amount percent</p> + <p> +validation regex for gap amount percent +</p> </div> @@ -138,7 +140,8 @@ that you can add to your worksheet.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>0*(([0-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)%</span><span class='regexp_end'>/</span></span></pre></dd> + <dd><pre class="code"><span class='regexp val'>/0*(([0-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)%/</span> +</pre></dd> </dl> @@ -170,8 +173,9 @@ that you can add to your worksheet.</p> - <span class="summary_desc"><div class='inline'> -<p>The direction of the bars in the chart must be one of [:bar, :col].</p> + <span class="summary_desc"><div class='inline'><p> +The direction of the bars in the chart must be one of [:bar, :col]. +</p> </div></span> </li> @@ -196,8 +200,9 @@ that you can add to your worksheet.</p> - <span class="summary_desc"><div class='inline'> -<p>the category axis.</p> + <span class="summary_desc"><div class='inline'><p> +the category axis. +</p> </div></span> </li> @@ -222,9 +227,10 @@ that you can add to your worksheet.</p> - <span class="summary_desc"><div class='inline'> -<p>space between bar or column clusters, as a percentage of the bar or column -width.</p> + <span class="summary_desc"><div class='inline'><p> +space between bar or column clusters, as a percentage of the bar or column +width. +</p> </div></span> </li> @@ -249,9 +255,10 @@ width.</p> - <span class="summary_desc"><div class='inline'> -<p>space between bar or column clusters, as a percentage of the bar or column -width.</p> + <span class="summary_desc"><div class='inline'><p> +space between bar or column clusters, as a percentage of the bar or column +width. +</p> </div></span> </li> @@ -276,8 +283,9 @@ width.</p> - <span class="summary_desc"><div class='inline'> -<p>grouping for a column, line, or area chart.</p> + <span class="summary_desc"><div class='inline'><p> +grouping for a column, line, or area chart. +</p> </div></span> </li> @@ -302,9 +310,10 @@ width.</p> - <span class="summary_desc"><div class='inline'> -<p>The shabe of the bars or columns must be one of [:cone, :coneToMax, :box, -:cylinder, :pyramid, :pyramidToMax].</p> + <span class="summary_desc"><div class='inline'><p> +The shabe of the bars or columns must be one of [:cone, :coneToMax, :box, +:cylinder, :pyramid, :pyramidToMax]. +</p> </div></span> </li> @@ -329,8 +338,9 @@ width.</p> - <span class="summary_desc"><div class='inline'> -<p>the valueaxis.</p> + <span class="summary_desc"><div class='inline'><p> +the valueaxis. +</p> </div></span> </li> @@ -375,8 +385,9 @@ width.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a new bar chart object.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new bar chart object. +</p> </div></span> </li> @@ -398,8 +409,9 @@ width.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the bar chart.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the bar chart. +</p> </div></span> </li> @@ -430,8 +442,9 @@ width.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new bar chart object</p> + <p> +Creates a new bar chart object +</p> </div> @@ -450,8 +463,9 @@ width.</p> — - <div class='inline'> -<p>The workbook that owns this chart.</p> + <div class='inline'><p> +The workbook that owns this chart. +</p> </div> </li> @@ -468,8 +482,9 @@ width.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -636,18 +651,19 @@ width.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 61</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id frame'>frame</span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='ivar'>@barDir</span> <span class='op'>=</span> <span class='symbol'>:bar</span> - <span class='ivar'>@grouping</span> <span class='op'>=</span> <span class='symbol'>:clustered</span> - <span class='ivar'>@gapWidth</span><span class='comma'>,</span> <span class='ivar'>@gapDepth</span><span class='comma'>,</span> <span class='ivar'>@shape</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span> - <span class='ivar'>@catAxId</span> <span class='op'>=</span> <span class='id rand'>rand</span><span class='lparen'>(</span><span class='int'>8</span> <span class='op'>**</span> <span class='int'>8</span><span class='rparen'>)</span> - <span class='ivar'>@valAxId</span> <span class='op'>=</span> <span class='id rand'>rand</span><span class='lparen'>(</span><span class='int'>8</span> <span class='op'>**</span> <span class='int'>8</span><span class='rparen'>)</span> - <span class='ivar'>@catAxis</span> <span class='op'>=</span> <span class='const'>CatAxis</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='ivar'>@catAxId</span><span class='comma'>,</span> <span class='ivar'>@valAxId</span><span class='rparen'>)</span> - <span class='ivar'>@valAxis</span> <span class='op'>=</span> <span class='const'>ValAxis</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='ivar'>@valAxId</span><span class='comma'>,</span> <span class='ivar'>@catAxId</span><span class='rparen'>)</span> - <span class='kw'>super</span><span class='lparen'>(</span><span class='id frame'>frame</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> - <span class='ivar'>@series_type</span> <span class='op'>=</span> <span class='const'>BarSeries</span> - <span class='ivar'>@view3D</span> <span class='op'>=</span> <span class='const'>View3D</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='symbol'>:rAngAx</span><span class='op'>=></span><span class='int'>1</span><span class='rbrace'>}</span><span class='period'>.</span><span class='id merge'>merge</span><span class='lparen'>(</span><span class='id options'>options</span><span class='rparen'>)</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='frame identifier id'>frame</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@barDir ivar id'>@barDir</span> <span class='assign token'>=</span> <span class='symbol val'>:bar</span> + <span class='@grouping ivar id'>@grouping</span> <span class='assign token'>=</span> <span class='symbol val'>:clustered</span> + <span class='@gapWidth ivar id'>@gapWidth</span><span class='comma token'>,</span> <span class='@gapDepth ivar id'>@gapDepth</span><span class='comma token'>,</span> <span class='@shape ivar id'>@shape</span> <span class='assign token'>=</span> <span class='nil nil kw'>nil</span><span class='comma token'>,</span> <span class='nil nil kw'>nil</span><span class='comma token'>,</span> <span class='nil nil kw'>nil</span> + <span class='@catAxId ivar id'>@catAxId</span> <span class='assign token'>=</span> <span class='rand identifier id'>rand</span><span class='lparen token'>(</span><span class='integer val'>8</span> <span class='pow op'>**</span> <span class='integer val'>8</span><span class='rparen token'>)</span> + <span class='@valAxId ivar id'>@valAxId</span> <span class='assign token'>=</span> <span class='rand identifier id'>rand</span><span class='lparen token'>(</span><span class='integer val'>8</span> <span class='pow op'>**</span> <span class='integer val'>8</span><span class='rparen token'>)</span> + <span class='@catAxis ivar id'>@catAxis</span> <span class='assign token'>=</span> <span class='CatAxis constant id'>CatAxis</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='@catAxId ivar id'>@catAxId</span><span class='comma token'>,</span> <span class='@valAxId ivar id'>@valAxId</span><span class='rparen token'>)</span> + <span class='@valAxis ivar id'>@valAxis</span> <span class='assign token'>=</span> <span class='ValAxis constant id'>ValAxis</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='@valAxId ivar id'>@valAxId</span><span class='comma token'>,</span> <span class='@catAxId ivar id'>@catAxId</span><span class='rparen token'>)</span> + <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='frame identifier id'>frame</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='@series_type ivar id'>@series_type</span> <span class='assign token'>=</span> <span class='BarSeries constant id'>BarSeries</span> + <span class='@view3D ivar id'>@view3D</span> <span class='assign token'>=</span> <span class='View3D constant id'>View3D</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='lbrace token'>{</span><span class='symbol val'>:rAngAx=</span><span class='gt op'>></span><span class='integer val'>1</span><span class='rbrace token'>}</span><span class='dot token'>.</span><span class='merge identifier id'>merge</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='rparen token'>)</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -670,8 +686,9 @@ width.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The direction of the bars in the chart must be one of [:bar, :col]</p> + <p> +The direction of the bars in the chart must be one of [:bar, :col] +</p> </div> @@ -705,9 +722,10 @@ width.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 21</span> -<span class='kw'>def</span> <span class='id barDir'>barDir</span> - <span class='ivar'>@barDir</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='barDir identifier id'>barDir</span> + <span class='@barDir ivar id'>@barDir</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -725,8 +743,9 @@ width.</p> </p><div class="docstring"> <div class="discussion"> - -<p>the category axis</p> + <p> +the category axis +</p> </div> @@ -760,9 +779,10 @@ width.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 12</span> -<span class='kw'>def</span> <span class='id catAxis'>catAxis</span> - <span class='ivar'>@catAxis</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='catAxis identifier id'>catAxis</span> + <span class='@catAxis ivar id'>@catAxis</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -780,9 +800,10 @@ width.</p> </p><div class="docstring"> <div class="discussion"> - -<p>space between bar or column clusters, as a percentage of the bar or column -width.</p> + <p> +space between bar or column clusters, as a percentage of the bar or column +width. +</p> </div> @@ -816,9 +837,10 @@ width.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 25</span> -<span class='kw'>def</span> <span class='id gapDepth'>gapDepth</span> - <span class='ivar'>@gapDepth</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='gapDepth identifier id'>gapDepth</span> + <span class='@gapDepth ivar id'>@gapDepth</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -836,9 +858,10 @@ width.</p> </p><div class="docstring"> <div class="discussion"> - -<p>space between bar or column clusters, as a percentage of the bar or column -width.</p> + <p> +space between bar or column clusters, as a percentage of the bar or column +width. +</p> </div> @@ -872,9 +895,10 @@ width.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 29</span> -<span class='kw'>def</span> <span class='id gapWidth'>gapWidth</span> - <span class='ivar'>@gapWidth</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='gapWidth identifier id'>gapWidth</span> + <span class='@gapWidth ivar id'>@gapWidth</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -892,9 +916,10 @@ width.</p> </p><div class="docstring"> <div class="discussion"> - -<p>grouping for a column, line, or area chart. must be one of -[:percentStacked, :clustered, :standard, :stacked]</p> + <p> +grouping for a column, line, or area chart. must be one of +[:percentStacked, :clustered, :standard, :stacked] +</p> </div> @@ -928,9 +953,10 @@ width.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 34</span> -<span class='kw'>def</span> <span class='id grouping'>grouping</span> - <span class='ivar'>@grouping</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='grouping identifier id'>grouping</span> + <span class='@grouping ivar id'>@grouping</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -948,9 +974,10 @@ width.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The shabe of the bars or columns must be one of [:cone, :coneToMax, :box, -:cylinder, :pyramid, :pyramidToMax]</p> + <p> +The shabe of the bars or columns must be one of [:cone, :coneToMax, :box, +:cylinder, :pyramid, :pyramidToMax] +</p> </div> @@ -984,9 +1011,10 @@ width.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 39</span> -<span class='kw'>def</span> <span class='id shape'>shape</span> - <span class='ivar'>@shape</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='shape identifier id'>shape</span> + <span class='@shape ivar id'>@shape</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1004,8 +1032,9 @@ width.</p> </p><div class="docstring"> <div class="discussion"> - -<p>the valueaxis</p> + <p> +the valueaxis +</p> </div> @@ -1039,9 +1068,10 @@ width.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 16</span> -<span class='kw'>def</span> <span class='id valAxis'>valAxis</span> - <span class='ivar'>@valAxis</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='valAxis identifier id'>valAxis</span> + <span class='@valAxis ivar id'>@valAxis</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1063,8 +1093,9 @@ width.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the bar chart</p> + <p> +Serializes the bar chart +</p> </div> @@ -1113,24 +1144,25 @@ width.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 109</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span> - <span class='kw'>super</span><span class='lparen'>(</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id xml'>xml</span><span class='op'>|</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:bar3DChart</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:barDir</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span> <span class='op'>=></span> <span class='id barDir'>barDir</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:grouping</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='id grouping'>grouping</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:varyColors</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='int'>1</span><span class='rparen'>)</span> - <span class='ivar'>@series</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id ser'>ser</span><span class='op'>|</span> <span class='id ser'>ser</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> <span class='rbrace'>}</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:gapWidth</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@gapWidth</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@gapWidth</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:gapDepth</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@gapDepth</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@gapDepth</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:shape</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@shape</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@shape</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:axId</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@catAxId</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:axId</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@valAxId</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:axId</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='int'>0</span><span class='rparen'>)</span> - <span class='rbrace'>}</span> - <span class='ivar'>@catAxis</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='ivar'>@valAxis</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='kw'>end</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span> + <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:bar3DChart'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:barDir'</span><span class='comma token'>,</span> <span class='symbol val'>:val</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='barDir identifier id'>barDir</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:grouping'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='grouping identifier id'>grouping</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:varyColors'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='integer val'>1</span><span class='rparen token'>)</span> + <span class='@series ivar id'>@series</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='ser identifier id'>ser</span><span class='bitor op'>|</span> <span class='ser identifier id'>ser</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:gapWidth'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@gapWidth ivar id'>@gapWidth</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@gapWidth ivar id'>@gapWidth</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:gapDepth'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@gapDepth ivar id'>@gapDepth</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@gapDepth ivar id'>@gapDepth</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:shape'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@shape ivar id'>@shape</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@shape ivar id'>@shape</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:axId'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@catAxId ivar id'>@catAxId</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:axId'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@valAxId ivar id'>@valAxId</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:axId'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='@catAxis ivar id'>@catAxis</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='@valAxis ivar id'>@valAxis</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1141,9 +1173,9 @@ width.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:38 2011 by + Generated on Sun Nov 27 18:05:20 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/BarSeries.html b/doc/Axlsx/BarSeries.html index 14660129..44a77f03 100644 --- a/doc/Axlsx/BarSeries.html +++ b/doc/Axlsx/BarSeries.html @@ -99,13 +99,15 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage series is to use Chart#add_series</p> + <div class='inline'><p> +The recommended way to manage series is to use Chart#add_series +</p> </div> </div> - -<p>A BarSeries defines the title, data and labels for bar charts</p> +<p> +A BarSeries defines the title, data and labels for bar charts +</p> </div> @@ -150,8 +152,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The data for this series.</p> + <span class="summary_desc"><div class='inline'><p> +The data for this series. +</p> </div></span> </li> @@ -176,8 +179,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The labels for this series.</p> + <span class="summary_desc"><div class='inline'><p> +The labels for this series. +</p> </div></span> </li> @@ -202,9 +206,10 @@ - <span class="summary_desc"><div class='inline'> -<p>The shabe of the bars or columns must be one of [:percentStacked, -:clustered, :standard, :stacked].</p> + <span class="summary_desc"><div class='inline'><p> +The shabe of the bars or columns must be one of [:percentStacked, +:clustered, :standard, :stacked]. +</p> </div></span> </li> @@ -249,8 +254,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Creates a new series.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new series. +</p> </div></span> </li> @@ -272,8 +278,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Serializes the series.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the series. +</p> </div></span> </li> @@ -304,8 +311,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new series</p> + <p> +Creates a new series +</p> </div> @@ -337,8 +345,9 @@ — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -409,12 +418,13 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_series.rb', line 28</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id chart'>chart</span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='ivar'>@shape</span> <span class='op'>=</span> <span class='symbol'>:box</span> - <span class='kw'>super</span><span class='lparen'>(</span><span class='id chart'>chart</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id labels'>labels</span> <span class='op'>=</span> <span class='const'>CatAxisData</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:labels</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:labels</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id data'>data</span> <span class='op'>=</span> <span class='const'>ValAxisData</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:data</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:data</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='chart identifier id'>chart</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@shape ivar id'>@shape</span> <span class='assign token'>=</span> <span class='symbol val'>:box</span> + <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='chart identifier id'>chart</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='labels identifier id'>labels</span> <span class='assign token'>=</span> <span class='CatAxisData constant id'>CatAxisData</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:labels</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:labels</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='data identifier id'>data</span> <span class='assign token'>=</span> <span class='ValAxisData constant id'>ValAxisData</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:data</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:data</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -437,8 +447,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>The data for this series.</p> + <p> +The data for this series. +</p> </div> @@ -472,9 +483,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_series.rb', line 11</span> -<span class='kw'>def</span> <span class='id data'>data</span> - <span class='ivar'>@data</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='data identifier id'>data</span> + <span class='@data ivar id'>@data</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -492,8 +504,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>The labels for this series.</p> + <p> +The labels for this series. +</p> </div> @@ -527,9 +540,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_series.rb', line 15</span> -<span class='kw'>def</span> <span class='id labels'>labels</span> - <span class='ivar'>@labels</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='labels identifier id'>labels</span> + <span class='@labels ivar id'>@labels</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -547,9 +561,10 @@ </p><div class="docstring"> <div class="discussion"> - -<p>The shabe of the bars or columns must be one of [:percentStacked, -:clustered, :standard, :stacked]</p> + <p> +The shabe of the bars or columns must be one of [:percentStacked, +:clustered, :standard, :stacked] +</p> </div> @@ -583,9 +598,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_series.rb', line 20</span> -<span class='kw'>def</span> <span class='id shape'>shape</span> - <span class='ivar'>@shape</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='shape identifier id'>shape</span> + <span class='@shape ivar id'>@shape</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -607,8 +623,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the series</p> + <p> +Serializes the series +</p> </div> @@ -627,8 +644,9 @@ — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -666,13 +684,14 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_series.rb', line 45</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='kw'>super</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id xml_inner'>xml_inner</span><span class='op'>|</span> - <span class='ivar'>@labels</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml_inner'>xml_inner</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@labels</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='ivar'>@data</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml_inner'>xml_inner</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@data</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='id xml_inner'>xml_inner</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:shape</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@shape</span><span class='rparen'>)</span> - <span class='kw'>end</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml_inner identifier id'>xml_inner</span><span class='bitor op'>|</span> + <span class='@labels ivar id'>@labels</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml_inner identifier id'>xml_inner</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@labels ivar id'>@labels</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='@data ivar id'>@data</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml_inner identifier id'>xml_inner</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@data ivar id'>@data</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='xml_inner identifier id'>xml_inner</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:shape'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@shape ivar id'>@shape</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -683,9 +702,9 @@ </div> <div id="footer"> - Generated on Sat Nov 26 13:16:38 2011 by + Generated on Sun Nov 27 18:05:15 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/Border.html b/doc/Axlsx/Border.html index 26e5cfff..18ebcd51 100644 --- a/doc/Axlsx/Border.html +++ b/doc/Axlsx/Border.html @@ -94,8 +94,9 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>This class details a border used in Office Open XML spreadsheet styles.</p> + <p> +This class details a border used in Office Open XML spreadsheet styles. +</p> </div> @@ -127,10 +128,11 @@ - <span class="summary_desc"><div class='inline'> -<p>The diagonal down property for the border that indicates if the border + <span class="summary_desc"><div class='inline'><p> +The diagonal down property for the border that indicates if the border should include a diagonal line from the top left to the top right of the -cell.</p> +cell. +</p> </div></span> </li> @@ -155,9 +157,10 @@ cell.</p> - <span class="summary_desc"><div class='inline'> -<p>The diagonal up property for the border that indicates if the border should -include a diagonal line from the bottom left to the top right of the cell.</p> + <span class="summary_desc"><div class='inline'><p> +The diagonal up property for the border that indicates if the border should +include a diagonal line from the bottom left to the top right of the cell. +</p> </div></span> </li> @@ -182,10 +185,11 @@ include a diagonal line from the bottom left to the top right of the cell.</p> - <span class="summary_desc"><div class='inline'> -<p>The outline property for the border indicating that top, left, right and + <span class="summary_desc"><div class='inline'><p> +The outline property for the border indicating that top, left, right and bottom borders should only be applied to the outside border of a range of -cells.</p> +cells. +</p> </div></span> </li> @@ -210,8 +214,9 @@ cells.</p> - <span class="summary_desc"><div class='inline'> -<p>A list of BorderPr objects for this border.</p> + <span class="summary_desc"><div class='inline'><p> +A list of BorderPr objects for this border. +</p> </div></span> </li> @@ -248,8 +253,9 @@ cells.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a new Border object.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new Border object. +</p> </div></span> </li> @@ -271,8 +277,9 @@ cells.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the border element.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the border element. +</p> </div></span> </li> @@ -293,8 +300,9 @@ cells.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new Border object</p> + <p> +Creates a new Border object +</p> </div> @@ -304,18 +312,20 @@ cells.</p> <div class="examples"> <h3>Examples:</h3> - <h4><div class='inline'> -<p>Making a border</p> + <h4><div class='inline'><p> +Making a border +</p> </div></h4> - <pre class="example code">p = Package.new -red_border = Border.new -[:left, :right, :top, :bottom].each do |item| - red_border.prs << BorderPr.new(:name=>item, :style=>:thin, :color=>Color.new(:rgb=>"FFFF0000")) # -end -# this sets red_border to be the index for the created border. -red_border = p.workbook.styles.@borders << red_border -#used in row creation as follows. This will add a red border to each of the cells in the row. -p.workbook.add_worksheet.rows << :values=>[1,2,3] :style=>red_border</pre> + <pre class="example code"><span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> +<span class='red_border identifier id'>red_border</span> <span class='assign token'>=</span> <span class='Border constant id'>Border</span><span class='dot token'>.</span><span class='new identifier id'>new</span> +<span class='lbrack token'>[</span><span class='symbol val'>:left</span><span class='comma token'>,</span> <span class='symbol val'>:right</span><span class='comma token'>,</span> <span class='symbol val'>:top</span><span class='comma token'>,</span> <span class='symbol val'>:bottom</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='item identifier id'>item</span><span class='bitor op'>|</span> + <span class='red_border identifier id'>red_border</span><span class='dot token'>.</span><span class='prs identifier id'>prs</span> <span class='lshft op'><<</span> <span class='BorderPr constant id'>BorderPr</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:name=</span><span class='gt op'>></span><span class='item identifier id'>item</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='symbol val'>:thin</span><span class='comma token'>,</span> <span class='symbol val'>:color=</span><span class='gt op'>></span><span class='Color constant id'>Color</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:rgb=</span><span class='gt op'>></span><span class='string val'>"FFFF0000"</span><span class='rparen token'>)</span><span class='rparen token'>)</span> <span class='comment val'># </span> +<span class='end end kw'>end</span> +<span class='comment val'># this sets red_border to be the index for the created border.</span> +<span class='red_border identifier id'>red_border</span> <span class='assign token'>=</span> <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='@borders ivar id'>@borders</span> <span class='lshft op'><<</span> <span class='red_border identifier id'>red_border</span> +<span class='comment val'>#used in row creation as follows. This will add a red border to each of the cells in the row.</span> +<span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span> <span class='lshft op'><<</span> <span class='symbol val'>:values=</span><span class='gt op'>></span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span><span class='integer val'>2</span><span class='comma token'>,</span><span class='integer val'>3</span><span class='rbrack token'>]</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='red_border identifier id'>red_border</span> +</pre> </div> <h3>Parameters:</h3> @@ -333,8 +343,9 @@ p.workbook.add_worksheet.rows << :values=>[1,2,3] :style=>red_border — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -394,12 +405,13 @@ p.workbook.add_worksheet.rows << :values=>[1,2,3] :style=>red_border <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border.rb', line 31</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='ivar'>@prs</span> <span class='op'>=</span> <span class='const'>SimpleTypedList</span><span class='period'>.</span><span class='id new'>new</span> <span class='const'>BorderPr</span> - <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span> - <span class='kw'>end</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@prs ivar id'>@prs</span> <span class='assign token'>=</span> <span class='SimpleTypedList constant id'>SimpleTypedList</span><span class='dot token'>.</span><span class='new identifier id'>new</span> <span class='BorderPr constant id'>BorderPr</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -422,10 +434,11 @@ p.workbook.add_worksheet.rows << :values=>[1,2,3] :style=>red_border </p><div class="docstring"> <div class="discussion"> - -<p>The diagonal down property for the border that indicates if the border + <p> +The diagonal down property for the border that indicates if the border should include a diagonal line from the top left to the top right of the -cell.</p> +cell. +</p> </div> @@ -443,10 +456,11 @@ cell.</p> — - <div class='inline'> -<p>The diagonal down property for the border that indicates if the border + <div class='inline'><p> +The diagonal down property for the border that indicates if the border should include a diagonal line from the top left to the top right of the -cell.</p> +cell. +</p> </div> </li> @@ -466,9 +480,10 @@ cell.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border.rb', line 9</span> -<span class='kw'>def</span> <span class='id diagonalDown'>diagonalDown</span> - <span class='ivar'>@diagonalDown</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='diagonalDown identifier id'>diagonalDown</span> + <span class='@diagonalDown ivar id'>@diagonalDown</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -486,9 +501,10 @@ cell.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The diagonal up property for the border that indicates if the border should -include a diagonal line from the bottom left to the top right of the cell.</p> + <p> +The diagonal up property for the border that indicates if the border should +include a diagonal line from the bottom left to the top right of the cell. +</p> </div> @@ -506,9 +522,10 @@ include a diagonal line from the bottom left to the top right of the cell.</p> — - <div class='inline'> -<p>The diagonal up property for the border that indicates if the border should -include a diagonal line from the bottom left to the top right of the cell.</p> + <div class='inline'><p> +The diagonal up property for the border that indicates if the border should +include a diagonal line from the bottom left to the top right of the cell. +</p> </div> </li> @@ -528,9 +545,10 @@ include a diagonal line from the bottom left to the top right of the cell.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border.rb', line 6</span> -<span class='kw'>def</span> <span class='id diagonalUp'>diagonalUp</span> - <span class='ivar'>@diagonalUp</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='diagonalUp identifier id'>diagonalUp</span> + <span class='@diagonalUp ivar id'>@diagonalUp</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -548,10 +566,11 @@ include a diagonal line from the bottom left to the top right of the cell.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The outline property for the border indicating that top, left, right and + <p> +The outline property for the border indicating that top, left, right and bottom borders should only be applied to the outside border of a range of -cells.</p> +cells. +</p> </div> @@ -569,10 +588,11 @@ cells.</p> — - <div class='inline'> -<p>The outline property for the border indicating that top, left, right and + <div class='inline'><p> +The outline property for the border indicating that top, left, right and bottom borders should only be applied to the outside border of a range of -cells.</p> +cells. +</p> </div> </li> @@ -592,9 +612,10 @@ cells.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border.rb', line 12</span> -<span class='kw'>def</span> <span class='id outline'>outline</span> - <span class='ivar'>@outline</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='outline identifier id'>outline</span> + <span class='@outline ivar id'>@outline</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -612,8 +633,9 @@ cells.</p> </p><div class="docstring"> <div class="discussion"> - -<p>A list of BorderPr objects for this border.</p> + <p> +A list of BorderPr objects for this border. +</p> </div> @@ -631,8 +653,9 @@ cells.</p> — - <div class='inline'> -<p>A list of BorderPr objects for this border.</p> + <div class='inline'><p> +A list of BorderPr objects for this border. +</p> </div> </li> @@ -652,9 +675,10 @@ cells.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border.rb', line 15</span> -<span class='kw'>def</span> <span class='id prs'>prs</span> - <span class='ivar'>@prs</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='prs identifier id'>prs</span> + <span class='@prs ivar id'>@prs</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -676,8 +700,9 @@ cells.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the border element</p> + <p> +Serializes the border element +</p> </div> @@ -696,8 +721,9 @@ cells.</p> — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -724,15 +750,16 @@ cells.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border.rb', line 47</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id border'>border</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id instance_values'>instance_values</span><span class='period'>.</span><span class='id select'>select</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id k'>k</span><span class='comma'>,</span><span class='id v'>v</span><span class='op'>|</span> <span class='lbracket'>[</span><span class='symbol'>:diagonalUp</span><span class='comma'>,</span> <span class='symbol'>:diagonalDown</span><span class='comma'>,</span> <span class='symbol'>:outline</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id include?'>include?</span> <span class='id k'>k</span> <span class='rbrace'>}</span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='lbracket'>[</span><span class='symbol'>:start</span><span class='comma'>,</span> <span class='symbol'>:end</span><span class='comma'>,</span> <span class='symbol'>:left</span><span class='comma'>,</span> <span class='symbol'>:right</span><span class='comma'>,</span> <span class='symbol'>:top</span><span class='comma'>,</span> <span class='symbol'>:bottom</span><span class='comma'>,</span> <span class='symbol'>:diagonal</span><span class='comma'>,</span> <span class='symbol'>:vertical</span><span class='comma'>,</span> <span class='symbol'>:horizontal</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id k'>k</span><span class='op'>|</span> - <span class='ivar'>@prs</span><span class='period'>.</span><span class='id select'>select</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id pr'>pr</span><span class='op'>|</span> <span class='id pr'>pr</span><span class='period'>.</span><span class='id name'>name</span> <span class='op'>==</span> <span class='id k'>k</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id part'>part</span><span class='op'>|</span> - <span class='id part'>part</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='kw'>end</span> - <span class='kw'>end</span> - <span class='rbrace'>}</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='border identifier id'>border</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='dot token'>.</span><span class='select identifier id'>select</span><span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='k identifier id'>k</span><span class='comma token'>,</span><span class='v identifier id'>v</span><span class='bitor op'>|</span> <span class='lbrack token'>[</span><span class='symbol val'>:diagonalUp</span><span class='comma token'>,</span> <span class='symbol val'>:diagonalDown</span><span class='comma token'>,</span> <span class='symbol val'>:outline</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='include? fid id'>include?</span> <span class='k identifier id'>k</span> <span class='rbrace token'>}</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='lbrack token'>[</span><span class='symbol val'>:start</span><span class='comma token'>,</span> <span class='symbol val'>:end</span><span class='comma token'>,</span> <span class='symbol val'>:left</span><span class='comma token'>,</span> <span class='symbol val'>:right</span><span class='comma token'>,</span> <span class='symbol val'>:top</span><span class='comma token'>,</span> <span class='symbol val'>:bottom</span><span class='comma token'>,</span> <span class='symbol val'>:diagonal</span><span class='comma token'>,</span> <span class='symbol val'>:vertical</span><span class='comma token'>,</span> <span class='symbol val'>:horizontal</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='k identifier id'>k</span><span class='bitor op'>|</span> + <span class='@prs ivar id'>@prs</span><span class='dot token'>.</span><span class='select identifier id'>select</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='pr identifier id'>pr</span><span class='bitor op'>|</span> <span class='pr identifier id'>pr</span><span class='dot token'>.</span><span class='name identifier id'>name</span> <span class='eq op'>==</span> <span class='k identifier id'>k</span> <span class='rbrace token'>}</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='part identifier id'>part</span><span class='bitor op'>|</span> + <span class='part identifier id'>part</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> + <span class='end end kw'>end</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -743,9 +770,9 @@ cells.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:37 2011 by + Generated on Sun Nov 27 18:05:14 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/BorderPr.html b/doc/Axlsx/BorderPr.html index 47c49d87..334f4680 100644 --- a/doc/Axlsx/BorderPr.html +++ b/doc/Axlsx/BorderPr.html @@ -94,8 +94,9 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>A border part.</p> + <p> +A border part. +</p> </div> @@ -127,8 +128,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The color of this border part.</p> + <span class="summary_desc"><div class='inline'><p> +The color of this border part. +</p> </div></span> </li> @@ -153,8 +155,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The name of this border part.</p> + <span class="summary_desc"><div class='inline'><p> +The name of this border part. +</p> </div></span> </li> @@ -179,8 +182,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The syle of this border part.</p> + <span class="summary_desc"><div class='inline'><p> +The syle of this border part. +</p> </div></span> </li> @@ -217,8 +221,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Creates a new Border Part Object.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new Border Part Object. +</p> </div></span> </li> @@ -240,8 +245,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Serializes the border part.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the border part. +</p> </div></span> </li> @@ -262,8 +268,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new Border Part Object</p> + <p> +Creates a new Border Part Object +</p> </div> @@ -284,8 +291,9 @@ — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -351,11 +359,12 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border_pr.rb', line 46</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span> - <span class='kw'>end</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -378,8 +387,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>The color of this border part.</p> + <p> +The color of this border part. +</p> </div> @@ -397,8 +407,9 @@ — - <div class='inline'> -<p>The color of this border part.</p> + <div class='inline'><p> +The color of this border part. +</p> </div> </li> @@ -418,9 +429,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border_pr.rb', line 6</span> -<span class='kw'>def</span> <span class='id color'>color</span> - <span class='ivar'>@color</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='color identifier id'>color</span> + <span class='@color ivar id'>@color</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -441,23 +453,26 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The following are allowed</p> - -<pre class="code"><span class='symbol'>:start</span> -<span class='symbol'>:end</span> -<span class='symbol'>:left</span> -<span class='symbol'>:right</span> -<span class='symbol'>:top</span> -<span class='symbol'>:bottom</span> -<span class='symbol'>:diagonal</span> -<span class='symbol'>:vertical</span> -<span class='symbol'>:horizontal</span></pre> + <div class='inline'><p> +The following are allowed +</p> +<pre class="code"> + <span class='symbol val'>:start</span> + <span class='symbol val'>:end</span> + <span class='symbol val'>:left</span> + <span class='symbol val'>:right</span> + <span class='symbol val'>:top</span> + <span class='symbol val'>:bottom</span> + <span class='symbol val'>:diagonal</span> + <span class='symbol val'>:vertical</span> + <span class='symbol val'>:horizontal</span> +</pre> </div> </div> - -<p>The name of this border part</p> +<p> +The name of this border part +</p> </div> @@ -475,8 +490,9 @@ — - <div class='inline'> -<p>The name of this border part</p> + <div class='inline'><p> +The name of this border part +</p> </div> </li> @@ -496,9 +512,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border_pr.rb', line 39</span> -<span class='kw'>def</span> <span class='id name'>name</span> - <span class='ivar'>@name</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='name identifier id'>name</span> + <span class='@name ivar id'>@name</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -519,28 +536,31 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The following are allowed</p> - -<pre class="code"><span class='symbol'>:none</span> -<span class='symbol'>:thin</span> -<span class='symbol'>:medium</span> -<span class='symbol'>:dashed</span> -<span class='symbol'>:dotted</span> -<span class='symbol'>:thick</span> -<span class='symbol'>:double</span> -<span class='symbol'>:hair</span> -<span class='symbol'>:mediumDashed</span> -<span class='symbol'>:dashDot</span> -<span class='symbol'>:mediumDashDot</span> -<span class='symbol'>:dashDotDot</span> -<span class='symbol'>:mediumDashDotDot</span> -<span class='symbol'>:slantDashDot</span></pre> + <div class='inline'><p> +The following are allowed +</p> +<pre class="code"> + <span class='symbol val'>:none</span> + <span class='symbol val'>:thin</span> + <span class='symbol val'>:medium</span> + <span class='symbol val'>:dashed</span> + <span class='symbol val'>:dotted</span> + <span class='symbol val'>:thick</span> + <span class='symbol val'>:double</span> + <span class='symbol val'>:hair</span> + <span class='symbol val'>:mediumDashed</span> + <span class='symbol val'>:dashDot</span> + <span class='symbol val'>:mediumDashDot</span> + <span class='symbol val'>:dashDotDot</span> + <span class='symbol val'>:mediumDashDotDot</span> + <span class='symbol val'>:slantDashDot</span> +</pre> </div> </div> - -<p>The syle of this border part.</p> +<p> +The syle of this border part. +</p> </div> @@ -558,8 +578,9 @@ — - <div class='inline'> -<p>The syle of this border part.</p> + <div class='inline'><p> +The syle of this border part. +</p> </div> </li> @@ -579,9 +600,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border_pr.rb', line 25</span> -<span class='kw'>def</span> <span class='id style'>style</span> - <span class='ivar'>@style</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='style identifier id'>style</span> + <span class='@style ivar id'>@style</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -603,8 +625,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the border part</p> + <p> +Serializes the border part +</p> </div> @@ -623,8 +646,9 @@ — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -660,11 +684,12 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border_pr.rb', line 62</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='ivar'>@name</span><span class='comma'>,</span> <span class='symbol'>:style</span> <span class='op'>=></span> <span class='ivar'>@style</span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='ivar'>@color</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='ivar'>@color</span><span class='period'>.</span><span class='id is_a?'>is_a?</span> <span class='const'>Color</span> - <span class='rbrace'>}</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='@name ivar id'>@name</span><span class='comma token'>,</span> <span class='symbol val'>:style</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='@style ivar id'>@style</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='@color ivar id'>@color</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='@color ivar id'>@color</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span> <span class='Color constant id'>Color</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -675,9 +700,9 @@ </div> <div id="footer"> - Generated on Sat Nov 26 13:16:38 2011 by + Generated on Sun Nov 27 18:05:14 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/CatAxis.html b/doc/Axlsx/CatAxis.html index 59b286b7..1f15ae61 100644 --- a/doc/Axlsx/CatAxis.html +++ b/doc/Axlsx/CatAxis.html @@ -96,8 +96,9 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>A CatAxis object defines a chart category axis</p> + <p> +A CatAxis object defines a chart category axis +</p> </div> @@ -113,8 +114,9 @@ <dt id="LBL_OFFSET_REGEX-constant" class="">LBL_OFFSET_REGEX = <div class="docstring"> <div class="discussion"> - -<p>regex for validating label offset</p> + <p> +regex for validating label offset +</p> </div> @@ -124,7 +126,8 @@ </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>0*(([0-9])|([1-9][0-9])|([1-9][0-9][0-9])|1000)%</span><span class='regexp_end'>/</span></span></pre></dd> + <dd><pre class="code"><span class='regexp val'>/0*(([0-9])|([1-9][0-9])|([1-9][0-9][0-9])|1000)%/</span> +</pre></dd> </dl> @@ -156,9 +159,10 @@ - <span class="summary_desc"><div class='inline'> -<p>From the docs: This element specifies that this axis is a date or text axis -based on the data that is used for the axis labels, not a specific choice.</p> + <span class="summary_desc"><div class='inline'><p> +From the docs: This element specifies that this axis is a date or text axis +based on the data that is used for the axis labels, not a specific choice. +</p> </div></span> </li> @@ -183,9 +187,10 @@ based on the data that is used for the axis labels, not a specific choice.</p> - <span class="summary_desc"><div class='inline'> -<p>specifies how the perpendicular axis is crossed must be one of [:ctr, :l, -:r].</p> + <span class="summary_desc"><div class='inline'><p> +specifies how the perpendicular axis is crossed must be one of [:ctr, :l, +:r]. +</p> </div></span> </li> @@ -210,8 +215,9 @@ based on the data that is used for the axis labels, not a specific choice.</p> - <span class="summary_desc"><div class='inline'> -<p>The offset of the labels must be between a string between 0 and 1000.</p> + <span class="summary_desc"><div class='inline'><p> +The offset of the labels must be between a string between 0 and 1000. +</p> </div></span> </li> @@ -256,8 +262,9 @@ based on the data that is used for the axis labels, not a specific choice.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a new CatAxis object.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new CatAxis object. +</p> </div></span> </li> @@ -279,8 +286,9 @@ based on the data that is used for the axis labels, not a specific choice.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the category axis.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the category axis. +</p> </div></span> </li> @@ -306,8 +314,9 @@ based on the data that is used for the axis labels, not a specific choice.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new CatAxis object</p> + <p> +Creates a new CatAxis object +</p> </div> @@ -326,8 +335,9 @@ based on the data that is used for the axis labels, not a specific choice.</p> — - <div class='inline'> -<p>the id of this axis. Inherited</p> + <div class='inline'><p> +the id of this axis. Inherited +</p> </div> </li> @@ -342,8 +352,9 @@ based on the data that is used for the axis labels, not a specific choice.</p> — - <div class='inline'> -<p>the id of the perpendicular axis. Inherited</p> + <div class='inline'><p> +the id of the perpendicular axis. Inherited +</p> </div> </li> @@ -360,8 +371,9 @@ based on the data that is used for the axis labels, not a specific choice.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -384,8 +396,9 @@ based on the data that is used for the axis labels, not a specific choice.</p> <span class="default"> </span> - — <div class='inline'> -<p>Inherited</p> + — <div class='inline'><p> +Inherited +</p> </div> </li> @@ -395,8 +408,9 @@ based on the data that is used for the axis labels, not a specific choice.</p> <span class="default"> </span> - — <div class='inline'> -<p>Inherited</p> + — <div class='inline'><p> +Inherited +</p> </div> </li> @@ -406,8 +420,9 @@ based on the data that is used for the axis labels, not a specific choice.</p> <span class="default"> </span> - — <div class='inline'> -<p>Inherited</p> + — <div class='inline'><p> +Inherited +</p> </div> </li> @@ -458,12 +473,13 @@ based on the data that is used for the axis labels, not a specific choice.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.rb', line 31</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id axId'>axId</span><span class='comma'>,</span> <span class='id crossAx'>crossAx</span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id auto'>auto</span> <span class='op'>=</span> <span class='kw'>true</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id lblAlgn'>lblAlgn</span> <span class='op'>=</span> <span class='symbol'>:ctr</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id lblOffset'>lblOffset</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>100%</span><span class='tstring_end'>"</span></span> - <span class='kw'>super</span><span class='lparen'>(</span><span class='id axId'>axId</span><span class='comma'>,</span> <span class='id crossAx'>crossAx</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='axId identifier id'>axId</span><span class='comma token'>,</span> <span class='crossAx identifier id'>crossAx</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='auto identifier id'>auto</span> <span class='assign token'>=</span> <span class='true true kw'>true</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='lblAlgn identifier id'>lblAlgn</span> <span class='assign token'>=</span> <span class='symbol val'>:ctr</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='lblOffset identifier id'>lblOffset</span> <span class='assign token'>=</span> <span class='string val'>"100%"</span> + <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='axId identifier id'>axId</span><span class='comma token'>,</span> <span class='crossAx identifier id'>crossAx</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -486,9 +502,10 @@ based on the data that is used for the axis labels, not a specific choice.</p> </p><div class="docstring"> <div class="discussion"> - -<p>From the docs: This element specifies that this axis is a date or text axis -based on the data that is used for the axis labels, not a specific choice.</p> + <p> +From the docs: This element specifies that this axis is a date or text axis +based on the data that is used for the axis labels, not a specific choice. +</p> </div> @@ -522,9 +539,10 @@ based on the data that is used for the axis labels, not a specific choice.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.rb', line 7</span> -<span class='kw'>def</span> <span class='id auto'>auto</span> - <span class='ivar'>@auto</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='auto identifier id'>auto</span> + <span class='@auto ivar id'>@auto</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -542,9 +560,10 @@ based on the data that is used for the axis labels, not a specific choice.</p> </p><div class="docstring"> <div class="discussion"> - -<p>specifies how the perpendicular axis is crossed must be one of [:ctr, :l, -:r]</p> + <p> +specifies how the perpendicular axis is crossed must be one of [:ctr, :l, +:r] +</p> </div> @@ -578,9 +597,10 @@ based on the data that is used for the axis labels, not a specific choice.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.rb', line 12</span> -<span class='kw'>def</span> <span class='id lblAlgn'>lblAlgn</span> - <span class='ivar'>@lblAlgn</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='lblAlgn identifier id'>lblAlgn</span> + <span class='@lblAlgn ivar id'>@lblAlgn</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -598,8 +618,9 @@ based on the data that is used for the axis labels, not a specific choice.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The offset of the labels must be between a string between 0 and 1000</p> + <p> +The offset of the labels must be between a string between 0 and 1000 +</p> </div> @@ -633,9 +654,10 @@ based on the data that is used for the axis labels, not a specific choice.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.rb', line 17</span> -<span class='kw'>def</span> <span class='id lblOffset'>lblOffset</span> - <span class='ivar'>@lblOffset</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='lblOffset identifier id'>lblOffset</span> + <span class='@lblOffset ivar id'>@lblOffset</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -657,8 +679,9 @@ based on the data that is used for the axis labels, not a specific choice.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the category axis</p> + <p> +Serializes the category axis +</p> </div> @@ -677,8 +700,9 @@ based on the data that is used for the axis labels, not a specific choice.</p> — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -717,14 +741,15 @@ based on the data that is used for the axis labels, not a specific choice.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.rb', line 52</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:catAx</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='kw'>super</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:auto</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@auto</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:lblAlgn</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@lblAlgn</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:lblOffset</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@lblOffset</span><span class='rparen'>)</span> - <span class='rbrace'>}</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:catAx'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:auto'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@auto ivar id'>@auto</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:lblAlgn'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@lblAlgn ivar id'>@lblAlgn</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:lblOffset'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@lblOffset ivar id'>@lblOffset</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -735,9 +760,9 @@ based on the data that is used for the axis labels, not a specific choice.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:37 2011 by + Generated on Sun Nov 27 18:05:15 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/CatAxisData.html b/doc/Axlsx/CatAxisData.html index 188310aa..12bed40c 100644 --- a/doc/Axlsx/CatAxisData.html +++ b/doc/Axlsx/CatAxisData.html @@ -96,8 +96,9 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>The CatAxisData class serializes the category axis data for a chart</p> + <p> +The CatAxisData class serializes the category axis data for a chart +</p> </div> @@ -152,8 +153,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Create a new CatAxisData object.</p> + <span class="summary_desc"><div class='inline'><p> +Create a new CatAxisData object. +</p> </div></span> </li> @@ -175,8 +177,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Serializes the category axis data.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the category axis data. +</p> </div></span> </li> @@ -202,8 +205,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Create a new CatAxisData object</p> + <p> +Create a new CatAxisData object +</p> </div> @@ -224,9 +228,10 @@ — - <div class='inline'> -<p>the data for this category axis. This can be a simple array or a simple -typed list of cells.</p> + <div class='inline'><p> +the data for this category axis. This can be a simple array or a simple +typed list of cells. +</p> </div> </li> @@ -249,11 +254,12 @@ typed list of cells.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis_data.rb', line 7</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id data'>data</span><span class='op'>=</span><span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span> - <span class='kw'>super</span> <span class='const'>Object</span> - <span class='ivar'>@list</span><span class='period'>.</span><span class='id concat'>concat</span> <span class='id data'>data</span> <span class='kw'>if</span> <span class='id data'>data</span><span class='period'>.</span><span class='id is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Array</span><span class='rparen'>)</span> - <span class='id data'>data</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id i'>i</span><span class='op'>|</span> <span class='ivar'>@list</span> <span class='op'><<</span> <span class='id i'>i</span> <span class='rbrace'>}</span> <span class='kw'>if</span> <span class='id data'>data</span><span class='period'>.</span><span class='id is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>SimpleTypedList</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='data identifier id'>data</span><span class='assign token'>=</span><span class='lbrack token'>[</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> + <span class='super super kw'>super</span> <span class='Object constant id'>Object</span> + <span class='@list ivar id'>@list</span><span class='dot token'>.</span><span class='concat identifier id'>concat</span> <span class='data identifier id'>data</span> <span class='if if_mod kw'>if</span> <span class='data identifier id'>data</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Array constant id'>Array</span><span class='rparen token'>)</span> + <span class='data identifier id'>data</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='i identifier id'>i</span><span class='bitor op'>|</span> <span class='@list ivar id'>@list</span> <span class='lshft op'><<</span> <span class='i identifier id'>i</span> <span class='rbrace token'>}</span> <span class='if if_mod kw'>if</span> <span class='data identifier id'>data</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='SimpleTypedList constant id'>SimpleTypedList</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -285,8 +291,9 @@ typed list of cells.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the category axis data</p> + <p> +Serializes the category axis data +</p> </div> @@ -305,8 +312,9 @@ typed list of cells.</p> — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -353,22 +361,23 @@ typed list of cells.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis_data.rb', line 16</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:cat</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:strRef</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:f</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='id cell_range'>cell_range</span><span class='lparen'>(</span><span class='ivar'>@list</span><span class='rparen'>)</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:strCache</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:ptCount</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='id size'>size</span><span class='rparen'>)</span> - <span class='id each_with_index'>each_with_index</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id item'>item</span><span class='comma'>,</span> <span class='id index'>index</span><span class='op'>|</span> - <span class='id v'>v</span> <span class='op'>=</span> <span class='id item'>item</span><span class='period'>.</span><span class='id is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Cell</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id item'>item</span><span class='period'>.</span><span class='id value'>value</span> <span class='op'>:</span> <span class='id item'>item</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:pt</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:idx</span><span class='op'>=></span><span class='id index'>index</span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:v</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id v'>v</span><span class='rparen'>)</span> - <span class='rbrace'>}</span> - <span class='kw'>end</span> - <span class='rbrace'>}</span> - <span class='rbrace'>}</span> - <span class='rbrace'>}</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:cat'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:strRef'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:f'</span><span class='comma token'>,</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='cell_range identifier id'>cell_range</span><span class='lparen token'>(</span><span class='@list ivar id'>@list</span><span class='rparen token'>)</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:strCache'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:ptCount'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='size identifier id'>size</span><span class='rparen token'>)</span> + <span class='each_with_index identifier id'>each_with_index</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='item identifier id'>item</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span> + <span class='v identifier id'>v</span> <span class='assign token'>=</span> <span class='item identifier id'>item</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Cell constant id'>Cell</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='item identifier id'>item</span><span class='dot token'>.</span><span class='value identifier id'>value</span> <span class='colon op'>:</span> <span class='item identifier id'>item</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:pt'</span><span class='comma token'>,</span> <span class='symbol val'>:idx=</span><span class='gt op'>></span><span class='index identifier id'>index</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:v'</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -379,9 +388,9 @@ typed list of cells.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:39 2011 by + Generated on Sun Nov 27 18:05:02 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/Cell.html b/doc/Axlsx/Cell.html index 0873021a..f5e8ca97 100644 --- a/doc/Axlsx/Cell.html +++ b/doc/Axlsx/Cell.html @@ -97,20 +97,22 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to generate cells is via Worksheet#add_row</p> + <div class='inline'><p> +The recommended way to generate cells is via Worksheet#add_row +</p> </div> </div> - -<p>A cell in a worksheet. Cell stores inforamation requried to serialize a +<p> +A cell in a worksheet. Cell stores inforamation requried to serialize a single worksheet cell to xml. You must provde the Row that the cell belongs to and the cells value. The data type will automatically be determed if you do not specify the :type option. The default style will be applied if you -do not supply the :style option. Changing the cell's type will recast the -value to the type specified. Altering the cell's value via the property -accessor will also automatically cast the provided value to the cell's -type.</p> +do not supply the :style option. Changing the cell’s type will recast +the value to the type specified. Altering the cell’s value via the +property accessor will also automatically cast the provided value to the +cell’s type. +</p> </div> @@ -120,23 +122,25 @@ type.</p> <div class="examples"> <h3>Examples:</h3> - <h4><div class='inline'> -<p>Manually creating and manipulating Cell objects</p> + <h4><div class='inline'><p> +Manually creating and manipulating Cell objects +</p> </div></h4> - <pre class="example code"><span class='id ws'>ws</span> <span class='op'>=</span> <span class='const'>Workbook</span><span class='period'>.</span><span class='id new'>new</span><span class='period'>.</span><span class='id add_worksheet'>add_worksheet</span> -<span class='comment'># This is the simple, and recommended way to create cells. Data types will automatically be determined for you. -</span><span class='id ws'>ws</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='symbol'>:values</span> <span class='op'>=></span> <span class='lbracket'>[</span><span class='int'>1</span><span class='comma'>,</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>fish</span><span class='tstring_end'>"</span></span><span class='comma'>,</span><span class='const'>Time</span><span class='period'>.</span><span class='id now'>now</span><span class='rbracket'>]</span> + <pre class="example code"><span class='ws identifier id'>ws</span> <span class='assign token'>=</span> <span class='Workbook constant id'>Workbook</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> +<span class='comment val'># This is the simple, and recommended way to create cells. Data types will automatically be determined for you.</span> +<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span><span class='string val'>"fish"</span><span class='comma token'>,</span><span class='Time constant id'>Time</span><span class='dot token'>.</span><span class='now identifier id'>now</span><span class='rbrack token'>]</span> -<span class='comment'># but you can also do this -</span><span class='id r'>r</span> <span class='op'>=</span> <span class='id ws'>ws</span><span class='period'>.</span><span class='id add_row'>add_row</span> -<span class='id r'>r</span><span class='period'>.</span><span class='id add_cell'>add_cell</span> <span class='int'>1</span> +<span class='comment val'># but you can also do this</span> +<span class='r identifier id'>r</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> +<span class='r identifier id'>r</span><span class='dot token'>.</span><span class='add_cell identifier id'>add_cell</span> <span class='integer val'>1</span> -<span class='comment'># or even this -</span><span class='id r'>r</span> <span class='op'>=</span> <span class='id ws'>ws</span><span class='period'>.</span><span class='id add_row'>add_row</span> -<span class='id c'>c</span> <span class='op'>=</span> <span class='const'>Cell</span><span class='period'>.</span><span class='id new'>new</span> <span class='id row'>row</span><span class='comma'>,</span> <span class='int'>1</span><span class='comma'>,</span> <span class='symbol'>:value</span><span class='op'>=></span><span class='id integer'>integer</span> +<span class='comment val'># or even this</span> +<span class='r identifier id'>r</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> +<span class='c identifier id'>c</span> <span class='assign token'>=</span> <span class='Cell constant id'>Cell</span><span class='dot token'>.</span><span class='new identifier id'>new</span> <span class='row identifier id'>row</span><span class='comma token'>,</span> <span class='integer val'>1</span><span class='comma token'>,</span> <span class='symbol val'>:value=</span><span class='gt op'>></span><span class='integer identifier id'>integer</span> -<span class='comment'># cells can also be accessed via Row#cells. The example here changes the cells type, which will automatically updated the value from 1 to 1.0 -</span><span class='id r'>r</span><span class='period'>.</span><span class='id cells'>cells</span><span class='period'>.</span><span class='id last'>last</span><span class='period'>.</span><span class='id type'>type</span> <span class='op'>=</span> <span class='symbol'>:float</span></pre> +<span class='comment val'># cells can also be accessed via Row#cells. The example here changes the cells type, which will automatically updated the value from 1 to 1.0</span> +<span class='r identifier id'>r</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='type identifier id'>type</span> <span class='assign token'>=</span> <span class='symbol val'>:float</span> +</pre> </div> @@ -172,8 +176,9 @@ type.</p> - <span class="summary_desc"><div class='inline'> -<p>The row this cell belongs to.</p> + <span class="summary_desc"><div class='inline'><p> +The row this cell belongs to. +</p> </div></span> </li> @@ -198,8 +203,9 @@ type.</p> - <span class="summary_desc"><div class='inline'> -<p>The index of the cellXfs item to be applied to this cell.</p> + <span class="summary_desc"><div class='inline'><p> +The index of the cellXfs item to be applied to this cell. +</p> </div></span> </li> @@ -224,8 +230,9 @@ type.</p> - <span class="summary_desc"><div class='inline'> -<p>The cell's data type.</p> + <span class="summary_desc"><div class='inline'><p> +The cell’s data type. +</p> </div></span> </li> @@ -250,8 +257,9 @@ type.</p> - <span class="summary_desc"><div class='inline'> -<p>The value of this cell.</p> + <span class="summary_desc"><div class='inline'><p> +The value of this cell. +</p> </div></span> </li> @@ -273,6 +281,78 @@ type.</p> <li class="public "> <span class="summary_signature"> + <a href="#cast_value-instance_method" title="#cast_value (instance method)">- (Object) <strong>cast_value</strong>(v) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Cast the value into this cells data type. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#cell_type_from_value-instance_method" title="#cell_type_from_value (instance method)">- (Symbol) <strong>cell_type_from_value</strong>(v) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Determines the cell type based on the cell value. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#col_ref-instance_method" title="#col_ref (instance method)">- (String) <strong>col_ref</strong> </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +converts the column index into alphabetical values. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + <a href="#index-instance_method" title="#index (instance method)">- (Integer) <strong>index</strong> </a> @@ -286,8 +366,9 @@ type.</p> - <span class="summary_desc"><div class='inline'> -<p>The index of the cell in the containing row.</p> + <span class="summary_desc"><div class='inline'><p> +The index of the cell in the containing row. +</p> </div></span> </li> @@ -311,8 +392,9 @@ type.</p> - <span class="summary_desc"><div class='inline'> -<p>A new instance of Cell.</p> + <span class="summary_desc"><div class='inline'><p> +A new instance of Cell. +</p> </div></span> </li> @@ -334,8 +416,9 @@ type.</p> - <span class="summary_desc"><div class='inline'> -<p>The alpha(column)numeric(row) reference for this sell.</p> + <span class="summary_desc"><div class='inline'><p> +The alpha(column)numeric(row) reference for this sell. +</p> </div></span> </li> @@ -357,8 +440,9 @@ type.</p> - <span class="summary_desc"><div class='inline'> -<p>The absolute alpha(column)numeric(row) reference for this sell.</p> + <span class="summary_desc"><div class='inline'><p> +The absolute alpha(column)numeric(row) reference for this sell. +</p> </div></span> </li> @@ -380,8 +464,9 @@ type.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the cell.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the cell. +</p> </div></span> </li> @@ -402,8 +487,9 @@ type.</p> </p><div class="docstring"> <div class="discussion"> - -<p>A new instance of Cell</p> + <p> +A new instance of Cell +</p> </div> @@ -422,8 +508,9 @@ type.</p> — - <div class='inline'> -<p>The row this cell belongs to.</p> + <div class='inline'><p> +The row this cell belongs to. +</p> </div> </li> @@ -440,8 +527,9 @@ type.</p> — - <div class='inline'> -<p>The value associated with this cell.</p> + <div class='inline'><p> +The value associated with this cell. +</p> </div> </li> @@ -458,8 +546,9 @@ type.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -482,9 +571,10 @@ type.</p> <span class="default"> </span> - — <div class='inline'> -<p>The intended data type for this cell. If not specified the data type will -be determined internally based on the vlue provided.</p> + — <div class='inline'><p> +The intended data type for this cell. If not specified the data type will +be determined internally based on the vlue provided. +</p> </div> </li> @@ -494,9 +584,10 @@ be determined internally based on the vlue provided.</p> <span class="default"> </span> - — <div class='inline'> -<p>The index of the cellXfs item to be applied to this cell. If not specified, -the default style (0) will be applied.</p> + — <div class='inline'><p> +The index of the cellXfs item to be applied to this cell. If not specified, +the default style (0) will be applied. +</p> </div> </li> @@ -523,15 +614,16 @@ the default style (0) will be applied.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 69</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id row'>row</span><span class='comma'>,</span> <span class='id value'>value</span><span class='op'>=</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id row'>row</span><span class='op'>=</span><span class='id row'>row</span> - <span class='comment'>#reference for validation -</span> <span class='ivar'>@styles</span> <span class='op'>=</span> <span class='id row'>row</span><span class='period'>.</span><span class='id worksheet'>worksheet</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id styles'>styles</span> - <span class='ivar'>@type</span><span class='op'>=</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id cell_type_from_value'>cell_type_from_value</span><span class='lparen'>(</span><span class='id value'>value</span><span class='rparen'>)</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id style'>style</span> <span class='op'>=</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:style</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='int'>0</span> - <span class='ivar'>@value</span> <span class='op'>=</span> <span class='id cast_value'>cast_value</span><span class='lparen'>(</span><span class='id value'>value</span><span class='rparen'>)</span> - <span class='ivar'>@row</span><span class='period'>.</span><span class='id cells'>cells</span> <span class='op'><<</span> <span class='kw'>self</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='row identifier id'>row</span><span class='comma token'>,</span> <span class='value identifier id'>value</span><span class='assign token'>=</span><span class='string val'>""</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='row identifier id'>row</span><span class='assign token'>=</span><span class='row identifier id'>row</span> + <span class='comment val'>#reference for validation</span> + <span class='@styles ivar id'>@styles</span> <span class='assign token'>=</span> <span class='row identifier id'>row</span><span class='dot token'>.</span><span class='worksheet identifier id'>worksheet</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span> + <span class='@type ivar id'>@type</span><span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:type</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='cell_type_from_value identifier id'>cell_type_from_value</span><span class='lparen token'>(</span><span class='value identifier id'>value</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='style identifier id'>style</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:style</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='integer val'>0</span> + <span class='@value ivar id'>@value</span> <span class='assign token'>=</span> <span class='cast_value identifier id'>cast_value</span><span class='lparen token'>(</span><span class='value identifier id'>value</span><span class='rparen token'>)</span> + <span class='@row ivar id'>@row</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span> <span class='lshft op'><<</span> <span class='self self kw'>self</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -554,8 +646,9 @@ the default style (0) will be applied.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The row this cell belongs to.</p> + <p> +The row this cell belongs to. +</p> </div> @@ -589,9 +682,10 @@ the default style (0) will be applied.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 33</span> -<span class='kw'>def</span> <span class='id row'>row</span> - <span class='ivar'>@row</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='row identifier id'>row</span> + <span class='@row ivar id'>@row</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -609,8 +703,9 @@ the default style (0) will be applied.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The index of the cellXfs item to be applied to this cell.</p> + <p> +The index of the cellXfs item to be applied to this cell. +</p> </div> @@ -651,9 +746,10 @@ the default style (0) will be applied.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 29</span> -<span class='kw'>def</span> <span class='id style'>style</span> - <span class='ivar'>@style</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='style identifier id'>style</span> + <span class='@style ivar id'>@style</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -674,22 +770,26 @@ the default style (0) will be applied.</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>If the value provided cannot be cast into the type specified, type is -changed to :string and the following logic is applied.</p> - -<pre class="code">:string to :integer or :float, type coversions always return 0 or 0.0 -:string, :integer, or :float to :time conversions always return the original value as a string and set the cells type to :string.</pre> - -<p>No support is currently implemented for parsing time strings.</p> + <div class='inline'><p> +If the value provided cannot be cast into the type specified, type is +changed to :string and the following logic is applied. +</p> +<pre class="code"> + <span class='symbol val'>:string</span> <span class='to identifier id'>to</span> <span class='symbol val'>:integer</span> <span class='or or kw'>or</span> <span class='symbol val'>:float</span><span class='comma token'>,</span> <span class='type identifier id'>type</span> <span class='coversions identifier id'>coversions</span> <span class='always identifier id'>always</span> <span class='return return kw'>return</span> <span class='integer val'>0</span> <span class='or or kw'>or</span> <span class='integer val'>0</span><span class='integer val'>.0</span> + <span class='symbol val'>:string</span><span class='comma token'>,</span> <span class='symbol val'>:integer</span><span class='comma token'>,</span> <span class='or or kw'>or</span> <span class='symbol val'>:float</span> <span class='to identifier id'>to</span> <span class='symbol val'>:time</span> <span class='conversions identifier id'>conversions</span> <span class='always identifier id'>always</span> <span class='return return kw'>return</span> <span class='the identifier id'>the</span> <span class='original identifier id'>original</span> <span class='value identifier id'>value</span> <span class='as identifier id'>as</span> <span class='a identifier id'>a</span> <span class='string identifier id'>string</span> <span class='and and kw'>and</span> <span class='set identifier id'>set</span> <span class='the identifier id'>the</span> <span class='cells identifier id'>cells</span> <span class='type identifier id'>type</span> <span class='to identifier id'>to</span> <span class='symbol val'>:string</span><span class='dot token'>.</span> +</pre> +<p> +No support is currently implemented for parsing time strings. +</p> </div> </div> - -<p>The cell's data type. Currently only four types are supported, :time, +<p> +The cell’s data type. Currently only four types are supported, :time, :float, :integer and :string. Changing the type for a cell will recast the value into that type. If no type option is specified in the constructor, -the type is automatically determed.</p> +the type is automatically determed. +</p> </div> @@ -707,8 +807,9 @@ the type is automatically determed.</p> — - <div class='inline'> -<p>The type of data this cell’s value is cast to.</p> + <div class='inline'><p> +The type of data this cell’s value is cast to. +</p> </div> </li> @@ -725,8 +826,9 @@ the type is automatically determed.</p> — - <div class='inline'> -<p>Cell.type must be one of [:time, :float, :integer, :string]</p> + <div class='inline'><p> +Cell.type must be one of [:time, :float, :integer, :string] +</p> </div> </li> @@ -753,9 +855,10 @@ the type is automatically determed.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 46</span> -<span class='kw'>def</span> <span class='id type'>type</span> - <span class='ivar'>@type</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='type identifier id'>type</span> + <span class='@type ivar id'>@type</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -773,8 +876,9 @@ the type is automatically determed.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The value of this cell.</p> + <p> +The value of this cell. +</p> </div> @@ -792,8 +896,9 @@ the type is automatically determed.</p> - <div class='inline'> -<p>casted value based on cell’s type attribute.</p> + <div class='inline'><p> +casted value based on cell’s type attribute. +</p> </div> </li> @@ -813,9 +918,10 @@ the type is automatically determed.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 57</span> -<span class='kw'>def</span> <span class='id value'>value</span> - <span class='ivar'>@value</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='value identifier id'>value</span> + <span class='@value ivar id'>@value</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -829,16 +935,387 @@ the type is automatically determed.</p> <div class="method_details first"> - <p class="signature first" id="index-instance_method"> + <p class="signature first" id="cast_value-instance_method"> - - (<tt>Integer</tt>) <strong>index</strong> + - (<tt>Object</tt>) <strong>cast_value</strong>(v) + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +About Time - Time in OOXML is <b>different</b> from what you might expect. +The history as to why is interesting, but you can safely assume that if you +are generating docs on a mac, you will want to specify Workbook.1904 as +true when using time typed values. +</p> +</div> + </div> + +<p> +Cast the value into this cells data type. +</p> + + + </div> +</div> +<div class="tags"> + + + <h3>See Also:</h3> + <ul class="see"> + + <li>Axlsx#date1904</li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 169</span> + +<span class='def def kw'>def</span> <span class='cast_value identifier id'>cast_value</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='if if kw'>if</span> <span class='@type ivar id'>@type</span> <span class='eq op'>==</span> <span class='symbol val'>:time</span> <span class='andop op'>&&</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Time constant id'>Time</span><span class='rparen token'>)</span> + <span class='comment val'>#todo consider a time parsing method to convert strings to time</span> + <span class='epoc identifier id'>epoc</span> <span class='assign token'>=</span> <span class='Workbook constant id'>Workbook</span><span class='dot token'>.</span><span class='date1904 identifier id'>date1904</span> <span class='integer val'>? </span><span class='Time constant id'>Time</span><span class='dot token'>.</span><span class='local identifier id'>local</span><span class='lparen token'>(</span><span class='integer val'>1904</span><span class='comma token'>,</span><span class='integer val'>1</span><span class='comma token'>,</span><span class='integer val'>1</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='v identifier id'>v</span><span class='dot token'>.</span><span class='zone identifier id'>zone</span><span class='rparen token'>)</span> <span class='colon op'>:</span> <span class='Time constant id'>Time</span><span class='dot token'>.</span><span class='local identifier id'>local</span><span class='lparen token'>(</span><span class='integer val'>1900</span><span class='comma token'>,</span><span class='integer val'>1</span><span class='comma token'>,</span><span class='integer val'>1</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='v identifier id'>v</span><span class='dot token'>.</span><span class='zone identifier id'>zone</span><span class='rparen token'>)</span> + <span class='lparen token'>(</span><span class='lparen token'>(</span><span class='v identifier id'>v</span> <span class='minus op'>-</span> <span class='epoc identifier id'>epoc</span><span class='rparen token'>)</span> <span class='div op'>/</span><span class='float val'>60.0</span><span class='div op'>/</span><span class='float val'>60.0</span><span class='div op'>/</span><span class='float val'>24.0</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='to_f identifier id'>to_f</span> + <span class='elsif elsif kw'>elsif</span> <span class='@type ivar id'>@type</span> <span class='eq op'>==</span> <span class='symbol val'>:float</span> + <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_f identifier id'>to_f</span> + <span class='elsif elsif kw'>elsif</span> <span class='@type ivar id'>@type</span> <span class='eq op'>==</span> <span class='symbol val'>:integer</span> + <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_i identifier id'>to_i</span> + <span class='else else kw'>else</span> + <span class='@type ivar id'>@type</span> <span class='assign token'>=</span> <span class='symbol val'>:string</span> + <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span> + <span class='comment val'># curious as to why this would be the cells responsibility</span> + <span class='comment val'># convert your values before passing them in wankers! CGI.unescapeHTML(v.to_s).to_xs</span> + <span class='comment val'># to revert, load this once when the gem is loaded.</span> + <span class='comment val'># unless String.method_defined? :to_xs</span> + <span class='comment val'># require 'fast_xs' #dep</span> + <span class='comment val'># class String</span> + <span class='comment val'># alias_method :to_xs, :fast_xs</span> + <span class='comment val'># end</span> + <span class='comment val'># end</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="cell_type_from_value-instance_method"> + + - (<tt>Symbol</tt>) <strong>cell_type_from_value</strong>(v) + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +This is only used when a cell is created but no :type option is specified, +the following rules apply: +</p> +<ol> +<li>If the value is an instance of Time, the type is set to :time + +</li> +<li>:float and :integer types are determined by regular expression matching. + +</li> +<li>Anything that does not meet either of the above is determined to be +:string. + +</li> +</ol> +</div> + </div> + +<p> +Determines the cell type based on the cell value. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Symbol</tt>)</span> + + + + — + <div class='inline'><p> +The determined type +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 153</span> + +<span class='def def kw'>def</span> <span class='cell_type_from_value identifier id'>cell_type_from_value</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='if if kw'>if</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span> <span class='Time constant id'>Time</span> + <span class='symbol val'>:time</span> + <span class='elsif elsif kw'>elsif</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='dot token'>.</span><span class='match identifier id'>match</span><span class='lparen token'>(</span><span class='regexp val'>/\A[+-]?\d+?\Z/</span><span class='rparen token'>)</span> <span class='comment val'>#numeric</span> + <span class='symbol val'>:integer</span> + <span class='elsif elsif kw'>elsif</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='dot token'>.</span><span class='match identifier id'>match</span><span class='lparen token'>(</span><span class='regexp val'>/\A[+-]?\d+\.\d+?\Z/</span><span class='rparen token'>)</span> <span class='comment val'>#float</span> + <span class='symbol val'>:float</span> + <span class='else else kw'>else</span> + <span class='symbol val'>:string</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="col_ref-instance_method"> + + - (<tt>String</tt>) <strong>col_ref</strong> </p><div class="docstring"> <div class="discussion"> -<p>The index of the cell in the containing row.</p> + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +This follows the standard spreadsheet convention of naming columns A to Z, +followed by AA to AZ etc. +</p> +</div> + </div> + +<p> +converts the column index into alphabetical values. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 136</span> + +<span class='def def kw'>def</span> <span class='col_ref identifier id'>col_ref</span> + <span class='chars identifier id'>chars</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span> + <span class='index identifier id'>index</span> <span class='assign token'>=</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='index identifier id'>index</span> + <span class='while while kw'>while</span> <span class='index identifier id'>index</span> <span class='geq op'>>=</span> <span class='integer val'>26</span> <span class='do do kw'>do</span> + <span class='chars identifier id'>chars</span> <span class='lshft op'><<</span> <span class='lparen token'>(</span><span class='lparen token'>(</span><span class='index identifier id'>index</span> <span class='mod op'>%</span> <span class='integer val'>26</span><span class='rparen token'>)</span> <span class='plus op'>+</span> <span class='integer val'>65</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='chr identifier id'>chr</span> + <span class='index identifier id'>index</span> <span class='opasgn op'>/=</span> <span class='integer val'>26</span> + <span class='end end kw'>end</span> + <span class='chars identifier id'>chars</span> <span class='lshft op'><<</span> <span class='lparen token'>(</span><span class='lparen token'>(</span><span class='chars identifier id'>chars</span><span class='dot token'>.</span><span class='empty? fid id'>empty?</span> <span class='integer val'>? </span><span class='index identifier id'>index</span> <span class='colon op'>:</span> <span class='index identifier id'>index</span><span class='minus op'>-</span><span class='integer val'>1</span><span class='rparen token'>)</span> <span class='plus op'>+</span> <span class='integer val'>65</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='chr identifier id'>chr</span> + <span class='chars identifier id'>chars</span><span class='dot token'>.</span><span class='reverse identifier id'>reverse</span><span class='dot token'>.</span><span class='join identifier id'>join</span> + <span class='end end kw'>end</span> + + <span class='comment val'># Determines the cell type based on the cell value. </span> + <span class='comment val'># @note This is only used when a cell is created but no :type option is specified, the following rules apply:</span> + <span class='comment val'># 1. If the value is an instance of Time, the type is set to :time</span> + <span class='comment val'># 2. :float and :integer types are determined by regular expression matching.</span> + <span class='comment val'># 3. Anything that does not meet either of the above is determined to be :string.</span> + <span class='comment val'># @return [Symbol] The determined type</span> + <span class='def def kw'>def</span> <span class='cell_type_from_value identifier id'>cell_type_from_value</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='if if kw'>if</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span> <span class='Time constant id'>Time</span> + <span class='symbol val'>:time</span> + <span class='elsif elsif kw'>elsif</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='dot token'>.</span><span class='match identifier id'>match</span><span class='lparen token'>(</span><span class='regexp val'>/\A[+-]?\d+?\Z/</span><span class='rparen token'>)</span> <span class='comment val'>#numeric</span> + <span class='symbol val'>:integer</span> + <span class='elsif elsif kw'>elsif</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='dot token'>.</span><span class='match identifier id'>match</span><span class='lparen token'>(</span><span class='regexp val'>/\A[+-]?\d+\.\d+?\Z/</span><span class='rparen token'>)</span> <span class='comment val'>#float</span> + <span class='symbol val'>:float</span> + <span class='else else kw'>else</span> + <span class='symbol val'>:string</span> + <span class='end end kw'>end</span> + <span class='end end kw'>end</span> + + <span class='comment val'># Cast the value into this cells data type. </span> + <span class='comment val'># @note </span> + <span class='comment val'># About Time - Time in OOXML is *different* from what you might expect. The history as to why is interesting, but you can safely assume that if you are generating docs on a mac, you will want to specify Workbook.1904 as true when using time typed values.</span> + <span class='comment val'># @see Axlsx#date1904</span> + <span class='def def kw'>def</span> <span class='cast_value identifier id'>cast_value</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='if if kw'>if</span> <span class='@type ivar id'>@type</span> <span class='eq op'>==</span> <span class='symbol val'>:time</span> <span class='andop op'>&&</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Time constant id'>Time</span><span class='rparen token'>)</span> + <span class='comment val'>#todo consider a time parsing method to convert strings to time</span> + <span class='epoc identifier id'>epoc</span> <span class='assign token'>=</span> <span class='Workbook constant id'>Workbook</span><span class='dot token'>.</span><span class='date1904 identifier id'>date1904</span> <span class='integer val'>? </span><span class='Time constant id'>Time</span><span class='dot token'>.</span><span class='local identifier id'>local</span><span class='lparen token'>(</span><span class='integer val'>1904</span><span class='comma token'>,</span><span class='integer val'>1</span><span class='comma token'>,</span><span class='integer val'>1</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='v identifier id'>v</span><span class='dot token'>.</span><span class='zone identifier id'>zone</span><span class='rparen token'>)</span> <span class='colon op'>:</span> <span class='Time constant id'>Time</span><span class='dot token'>.</span><span class='local identifier id'>local</span><span class='lparen token'>(</span><span class='integer val'>1900</span><span class='comma token'>,</span><span class='integer val'>1</span><span class='comma token'>,</span><span class='integer val'>1</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='v identifier id'>v</span><span class='dot token'>.</span><span class='zone identifier id'>zone</span><span class='rparen token'>)</span> + <span class='lparen token'>(</span><span class='lparen token'>(</span><span class='v identifier id'>v</span> <span class='minus op'>-</span> <span class='epoc identifier id'>epoc</span><span class='rparen token'>)</span> <span class='div op'>/</span><span class='float val'>60.0</span><span class='div op'>/</span><span class='float val'>60.0</span><span class='div op'>/</span><span class='float val'>24.0</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='to_f identifier id'>to_f</span> + <span class='elsif elsif kw'>elsif</span> <span class='@type ivar id'>@type</span> <span class='eq op'>==</span> <span class='symbol val'>:float</span> + <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_f identifier id'>to_f</span> + <span class='elsif elsif kw'>elsif</span> <span class='@type ivar id'>@type</span> <span class='eq op'>==</span> <span class='symbol val'>:integer</span> + <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_i identifier id'>to_i</span> + <span class='else else kw'>else</span> + <span class='@type ivar id'>@type</span> <span class='assign token'>=</span> <span class='symbol val'>:string</span> + <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span> + <span class='comment val'># curious as to why this would be the cells responsibility</span> + <span class='comment val'># convert your values before passing them in wankers! CGI.unescapeHTML(v.to_s).to_xs</span> + <span class='comment val'># to revert, load this once when the gem is loaded.</span> + <span class='comment val'># unless String.method_defined? :to_xs</span> + <span class='comment val'># require 'fast_xs' #dep</span> + <span class='comment val'># class String</span> + <span class='comment val'># alias_method :to_xs, :fast_xs</span> + <span class='comment val'># end</span> + <span class='comment val'># end</span> + <span class='end end kw'>end</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="index-instance_method"> + + - (<tt>Integer</tt>) <strong>index</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The index of the cell in the containing row. +</p> </div> @@ -856,8 +1333,9 @@ the type is automatically determed.</p> — - <div class='inline'> -<p>The index of the cell in the containing row.</p> + <div class='inline'><p> +The index of the cell in the containing row. +</p> </div> </li> @@ -877,9 +1355,10 @@ the type is automatically determed.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 80</span> -<span class='kw'>def</span> <span class='id index'>index</span> - <span class='ivar'>@row</span><span class='period'>.</span><span class='id cells'>cells</span><span class='period'>.</span><span class='id index'>index</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='index identifier id'>index</span> + <span class='@row ivar id'>@row</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -894,8 +1373,9 @@ the type is automatically determed.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The alpha(column)numeric(row) reference for this sell.</p> + <p> +The alpha(column)numeric(row) reference for this sell. +</p> </div> @@ -905,10 +1385,12 @@ the type is automatically determed.</p> <div class="examples"> <h3>Examples:</h3> - <h4><div class='inline'> -<p>Relative Cell Reference</p> + <h4><div class='inline'><p> +Relative Cell Reference +</p> </div></h4> - <pre class="example code"><span class='id ws'>ws</span><span class='period'>.</span><span class='id rows'>rows</span><span class='period'>.</span><span class='id first'>first</span><span class='period'>.</span><span class='id cells'>cells</span><span class='period'>.</span><span class='id first'>first</span><span class='period'>.</span><span class='id r'>r</span> <span class='comment'>#=> "A1" </span></pre> + <pre class="example code"><span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='r identifier id'>r</span> <span class='comment val'>#=> "A1" </span> +</pre> </div> @@ -923,8 +1405,9 @@ the type is automatically determed.</p> — - <div class='inline'> -<p>The alpha(column)numeric(row) reference for this sell.</p> + <div class='inline'><p> +The alpha(column)numeric(row) reference for this sell. +</p> </div> </li> @@ -944,9 +1427,10 @@ the type is automatically determed.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 87</span> -<span class='kw'>def</span> <span class='id r'>r</span> - <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id col_ref'>col_ref</span><span class='rbrace'>}</span><span class='embexpr_beg'>#{</span><span class='ivar'>@row</span><span class='period'>.</span><span class='id index'>index</span><span class='op'>+</span><span class='int'>1</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='r identifier id'>r</span> + <span class='dstring node'>"#{col_ref}#{@row.index+1}"</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -961,8 +1445,9 @@ the type is automatically determed.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The absolute alpha(column)numeric(row) reference for this sell.</p> + <p> +The absolute alpha(column)numeric(row) reference for this sell. +</p> </div> @@ -972,10 +1457,12 @@ the type is automatically determed.</p> <div class="examples"> <h3>Examples:</h3> - <h4><div class='inline'> -<p>Absolute Cell Reference</p> + <h4><div class='inline'><p> +Absolute Cell Reference +</p> </div></h4> - <pre class="example code"><span class='id ws'>ws</span><span class='period'>.</span><span class='id rows'>rows</span><span class='period'>.</span><span class='id first'>first</span><span class='period'>.</span><span class='id cells'>cells</span><span class='period'>.</span><span class='id first'>first</span><span class='period'>.</span><span class='id r'>r</span> <span class='comment'>#=> "$A$1" </span></pre> + <pre class="example code"><span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='r identifier id'>r</span> <span class='comment val'>#=> "$A$1" </span> +</pre> </div> @@ -990,8 +1477,9 @@ the type is automatically determed.</p> — - <div class='inline'> -<p>The absolute alpha(column)numeric(row) reference for this sell.</p> + <div class='inline'><p> +The absolute alpha(column)numeric(row) reference for this sell. +</p> </div> </li> @@ -1011,9 +1499,10 @@ the type is automatically determed.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 94</span> -<span class='kw'>def</span> <span class='id r_abs'>r_abs</span> - <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>$</span><span class='embexpr_beg'>#{</span><span class='id r'>r</span><span class='period'>.</span><span class='id split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>$</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='r_abs identifier id'>r_abs</span> + <span class='dstring node'>"$#{r.split('').join('$')}"</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1031,14 +1520,16 @@ the type is automatically determed.</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>Shared Strings are not used in this library. All values are set directly in -the each sheet.</p> + <div class='inline'><p> +Shared Strings are not used in this library. All values are set directly in +the each sheet. +</p> </div> </div> - -<p>Serializes the cell</p> +<p> +Serializes the cell +</p> </div> @@ -1057,8 +1548,9 @@ the each sheet.</p> — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -1076,8 +1568,9 @@ the each sheet.</p> — - <div class='inline'> -<p>xml text for the cell</p> + <div class='inline'><p> +xml text for the cell +</p> </div> </li> @@ -1106,18 +1599,19 @@ the each sheet.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 114</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='comment'># Both 1.8 and 1.9 return the same 'fast_xf' -</span> <span class='comment'># &#12491;&#12507;&#12531;&#12468; -</span> <span class='comment'># &#12491;&#12507;&#12531;&#12468; -</span> - <span class='comment'># however nokogiri does a nice 'force_encoding' which we shall remove! -</span> <span class='kw'>if</span> <span class='ivar'>@type</span> <span class='op'>==</span> <span class='symbol'>:string</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id c'>c</span><span class='lparen'>(</span><span class='symbol'>:r</span> <span class='op'>=></span> <span class='id r'>r</span><span class='comma'>,</span> <span class='symbol'>:t</span><span class='op'>=></span><span class='symbol'>:inlineStr</span><span class='comma'>,</span> <span class='symbol'>:s</span><span class='op'>=></span><span class='id style'>style</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='id xml'>xml</span><span class='period'>.</span><span class='id is'>is</span> <span class='lbrace'>{</span> <span class='id xml'>xml</span><span class='period'>.</span><span class='id t'>t</span> <span class='ivar'>@value</span><span class='period'>.</span><span class='id to_s'>to_s</span> <span class='rbrace'>}</span> <span class='rbrace'>}</span> - <span class='kw'>else</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id c'>c</span><span class='lparen'>(</span><span class='symbol'>:r</span> <span class='op'>=></span> <span class='id r'>r</span><span class='comma'>,</span> <span class='symbol'>:s</span> <span class='op'>=></span> <span class='id style'>style</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='id xml'>xml</span><span class='period'>.</span><span class='id v'>v</span> <span class='id value'>value</span> <span class='rbrace'>}</span> - <span class='kw'>end</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='comment val'># Both 1.8 and 1.9 return the same 'fast_xf'</span> + <span class='comment val'># &#12491;&#12507;&#12531;&#12468;</span> + <span class='comment val'># &#12491;&#12507;&#12531;&#12468;</span> + + <span class='comment val'># however nokogiri does a nice 'force_encoding' which we shall remove!</span> + <span class='if if kw'>if</span> <span class='@type ivar id'>@type</span> <span class='eq op'>==</span> <span class='symbol val'>:string</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='c identifier id'>c</span><span class='lparen token'>(</span><span class='symbol val'>:r</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='r identifier id'>r</span><span class='comma token'>,</span> <span class='symbol val'>:t=</span><span class='gt op'>></span><span class='symbol val'>:inlineStr</span><span class='comma token'>,</span> <span class='symbol val'>:s=</span><span class='gt op'>></span><span class='style identifier id'>style</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='is identifier id'>is</span> <span class='lbrace token'>{</span> <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='t identifier id'>t</span> <span class='@value ivar id'>@value</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span> <span class='rbrace token'>}</span> <span class='rbrace token'>}</span> + <span class='else else kw'>else</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='c identifier id'>c</span><span class='lparen token'>(</span><span class='symbol val'>:r</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='r identifier id'>r</span><span class='comma token'>,</span> <span class='symbol val'>:s</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='style identifier id'>style</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='v identifier id'>v</span> <span class='value identifier id'>value</span> <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1128,9 +1622,9 @@ the each sheet.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:39 2011 by + Generated on Sun Nov 27 18:05:09 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/CellAlignment.html b/doc/Axlsx/CellAlignment.html index a1c73464..9f940a3f 100644 --- a/doc/Axlsx/CellAlignment.html +++ b/doc/Axlsx/CellAlignment.html @@ -97,14 +97,16 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>Using Styles#add_style is the recommended way to manage cell alignment.</p> + <div class='inline'><p> +Using Styles#add_style is the recommended way to manage cell alignment. +</p> </div> </div> - -<p>CellAlignment stores information about the cell alignment of a style Xf -Object.</p> +<p> +CellAlignment stores information about the cell alignment of a style Xf +Object. +</p> </div> @@ -143,8 +145,9 @@ Object.</p> - <span class="summary_desc"><div class='inline'> -<p>The horizontal alignment of the cell.</p> + <span class="summary_desc"><div class='inline'><p> +The horizontal alignment of the cell. +</p> </div></span> </li> @@ -169,8 +172,9 @@ Object.</p> - <span class="summary_desc"><div class='inline'> -<p>The amount of indent.</p> + <span class="summary_desc"><div class='inline'><p> +The amount of indent. +</p> </div></span> </li> @@ -195,8 +199,9 @@ Object.</p> - <span class="summary_desc"><div class='inline'> -<p>Indicate if the last line should be justified.</p> + <span class="summary_desc"><div class='inline'><p> +Indicate if the last line should be justified. +</p> </div></span> </li> @@ -221,9 +226,10 @@ Object.</p> - <span class="summary_desc"><div class='inline'> -<p>The reading order of the text 0 Context Dependent 1 Left-to-Right 2 -Right-to-Left.</p> + <span class="summary_desc"><div class='inline'><p> +The reading order of the text 0 Context Dependent 1 Left-to-Right 2 +Right-to-Left. +</p> </div></span> </li> @@ -248,8 +254,9 @@ Right-to-Left.</p> - <span class="summary_desc"><div class='inline'> -<p>The amount of relativeIndent.</p> + <span class="summary_desc"><div class='inline'><p> +The amount of relativeIndent. +</p> </div></span> </li> @@ -274,8 +281,9 @@ Right-to-Left.</p> - <span class="summary_desc"><div class='inline'> -<p>Indicate if the text should be shrunk to the fit in the cell.</p> + <span class="summary_desc"><div class='inline'><p> +Indicate if the text should be shrunk to the fit in the cell. +</p> </div></span> </li> @@ -300,8 +308,9 @@ Right-to-Left.</p> - <span class="summary_desc"><div class='inline'> -<p>The textRotation of the cell.</p> + <span class="summary_desc"><div class='inline'><p> +The textRotation of the cell. +</p> </div></span> </li> @@ -326,8 +335,9 @@ Right-to-Left.</p> - <span class="summary_desc"><div class='inline'> -<p>The vertical alignment of the cell.</p> + <span class="summary_desc"><div class='inline'><p> +The vertical alignment of the cell. +</p> </div></span> </li> @@ -352,8 +362,9 @@ Right-to-Left.</p> - <span class="summary_desc"><div class='inline'> -<p>Indicate if the text of the cell should wrap.</p> + <span class="summary_desc"><div class='inline'><p> +Indicate if the text of the cell should wrap. +</p> </div></span> </li> @@ -390,8 +401,9 @@ Right-to-Left.</p> - <span class="summary_desc"><div class='inline'> -<p>Create a new cell_alignment object.</p> + <span class="summary_desc"><div class='inline'><p> +Create a new cell_alignment object. +</p> </div></span> </li> @@ -413,8 +425,9 @@ Right-to-Left.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the cell alignment.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the cell alignment. +</p> </div></span> </li> @@ -435,8 +448,9 @@ Right-to-Left.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Create a new cell_alignment object</p> + <p> +Create a new cell_alignment object +</p> </div> @@ -457,8 +471,9 @@ Right-to-Left.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -571,11 +586,12 @@ Right-to-Left.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 72</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span> - <span class='kw'>end</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -601,22 +617,25 @@ Right-to-Left.</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The horizontal cell alignement style must be one of</p> - -<pre class="code"><span class='symbol'>:general</span> -<span class='symbol'>:left</span> -<span class='symbol'>:center</span> -<span class='symbol'>:right</span> -<span class='symbol'>:fill</span> -<span class='symbol'>:justify</span> -<span class='symbol'>:centerContinuous</span> -<span class='symbol'>:distributed</span></pre> + <div class='inline'><p> +The horizontal cell alignement style must be one of +</p> +<pre class="code"> + <span class='symbol val'>:general</span> + <span class='symbol val'>:left</span> + <span class='symbol val'>:center</span> + <span class='symbol val'>:right</span> + <span class='symbol val'>:fill</span> + <span class='symbol val'>:justify</span> + <span class='symbol val'>:centerContinuous</span> + <span class='symbol val'>:distributed</span> +</pre> </div> </div> - -<p>The horizontal alignment of the cell.</p> +<p> +The horizontal alignment of the cell. +</p> </div> @@ -650,9 +669,10 @@ Right-to-Left.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 18</span> -<span class='kw'>def</span> <span class='id horizontal'>horizontal</span> - <span class='ivar'>@horizontal</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='horizontal identifier id'>horizontal</span> + <span class='@horizontal ivar id'>@horizontal</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -670,8 +690,9 @@ Right-to-Left.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The amount of indent</p> + <p> +The amount of indent +</p> </div> @@ -705,9 +726,10 @@ Right-to-Left.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 41</span> -<span class='kw'>def</span> <span class='id indent'>indent</span> - <span class='ivar'>@indent</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='indent identifier id'>indent</span> + <span class='@indent ivar id'>@indent</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -725,8 +747,9 @@ Right-to-Left.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Indicate if the last line should be justified.</p> + <p> +Indicate if the last line should be justified. +</p> </div> @@ -760,9 +783,10 @@ Right-to-Left.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 49</span> -<span class='kw'>def</span> <span class='id justifyLastLine'>justifyLastLine</span> - <span class='ivar'>@justifyLastLine</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='justifyLastLine identifier id'>justifyLastLine</span> + <span class='@justifyLastLine ivar id'>@justifyLastLine</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -780,9 +804,10 @@ Right-to-Left.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The reading order of the text 0 Context Dependent 1 Left-to-Right 2 -Right-to-Left</p> + <p> +The reading order of the text 0 Context Dependent 1 Left-to-Right 2 +Right-to-Left +</p> </div> @@ -816,9 +841,10 @@ Right-to-Left</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 60</span> -<span class='kw'>def</span> <span class='id readingOrder'>readingOrder</span> - <span class='ivar'>@readingOrder</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='readingOrder identifier id'>readingOrder</span> + <span class='@readingOrder ivar id'>@readingOrder</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -836,8 +862,9 @@ Right-to-Left</p> </p><div class="docstring"> <div class="discussion"> - -<p>The amount of relativeIndent</p> + <p> +The amount of relativeIndent +</p> </div> @@ -871,9 +898,10 @@ Right-to-Left</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 45</span> -<span class='kw'>def</span> <span class='id relativeIndent'>relativeIndent</span> - <span class='ivar'>@relativeIndent</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='relativeIndent identifier id'>relativeIndent</span> + <span class='@relativeIndent ivar id'>@relativeIndent</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -891,8 +919,9 @@ Right-to-Left</p> </p><div class="docstring"> <div class="discussion"> - -<p>Indicate if the text should be shrunk to the fit in the cell.</p> + <p> +Indicate if the text should be shrunk to the fit in the cell. +</p> </div> @@ -926,9 +955,10 @@ Right-to-Left</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 53</span> -<span class='kw'>def</span> <span class='id shrinkToFit'>shrinkToFit</span> - <span class='ivar'>@shrinkToFit</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='shrinkToFit identifier id'>shrinkToFit</span> + <span class='@shrinkToFit ivar id'>@shrinkToFit</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -946,8 +976,9 @@ Right-to-Left</p> </p><div class="docstring"> <div class="discussion"> - -<p>The textRotation of the cell.</p> + <p> +The textRotation of the cell. +</p> </div> @@ -981,9 +1012,10 @@ Right-to-Left</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 33</span> -<span class='kw'>def</span> <span class='id textRotation'>textRotation</span> - <span class='ivar'>@textRotation</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='textRotation identifier id'>textRotation</span> + <span class='@textRotation ivar id'>@textRotation</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1004,19 +1036,22 @@ Right-to-Left</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The vertical cell allingment style must be one of the following:</p> - -<pre class="code"><span class='symbol'>:top</span> -<span class='symbol'>:center</span> -<span class='symbol'>:bottom</span> -<span class='symbol'>:justify</span> -<span class='symbol'>:distributed</span></pre> + <div class='inline'><p> +The vertical cell allingment style must be one of the following: +</p> +<pre class="code"> + <span class='symbol val'>:top</span> + <span class='symbol val'>:center</span> + <span class='symbol val'>:bottom</span> + <span class='symbol val'>:justify</span> + <span class='symbol val'>:distributed</span> +</pre> </div> </div> - -<p>The vertical alignment of the cell.</p> +<p> +The vertical alignment of the cell. +</p> </div> @@ -1050,9 +1085,10 @@ Right-to-Left</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 29</span> -<span class='kw'>def</span> <span class='id vertical'>vertical</span> - <span class='ivar'>@vertical</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='vertical identifier id'>vertical</span> + <span class='@vertical ivar id'>@vertical</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1070,8 +1106,9 @@ Right-to-Left</p> </p><div class="docstring"> <div class="discussion"> - -<p>Indicate if the text of the cell should wrap</p> + <p> +Indicate if the text of the cell should wrap +</p> </div> @@ -1105,9 +1142,10 @@ Right-to-Left</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 37</span> -<span class='kw'>def</span> <span class='id wrapText'>wrapText</span> - <span class='ivar'>@wrapText</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='wrapText identifier id'>wrapText</span> + <span class='@wrapText ivar id'>@wrapText</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1129,8 +1167,9 @@ Right-to-Left</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the cell alignment</p> + <p> +Serializes the cell alignment +</p> </div> @@ -1149,8 +1188,9 @@ Right-to-Left</p> — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -1184,9 +1224,10 @@ Right-to-Left</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 100</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id alignment'>alignment</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id instance_values'>instance_values</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='alignment identifier id'>alignment</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1197,9 +1238,9 @@ Right-to-Left</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:39 2011 by + Generated on Sun Nov 27 18:05:10 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/CellProtection.html b/doc/Axlsx/CellProtection.html index a62fe369..7e1648f1 100644 --- a/doc/Axlsx/CellProtection.html +++ b/doc/Axlsx/CellProtection.html @@ -97,14 +97,16 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>Using Styles#add_style is the recommended way to manage cell protection.</p> + <div class='inline'><p> +Using Styles#add_style is the recommended way to manage cell protection. +</p> </div> </div> - -<p>CellProtection stores information about locking or hiding cells in -spreadsheet.</p> +<p> +CellProtection stores information about locking or hiding cells in +spreadsheet. +</p> </div> @@ -143,8 +145,9 @@ spreadsheet.</p> - <span class="summary_desc"><div class='inline'> -<p>specifies locking for cells that have the style containing this protection.</p> + <span class="summary_desc"><div class='inline'><p> +specifies locking for cells that have the style containing this protection. +</p> </div></span> </li> @@ -169,8 +172,9 @@ spreadsheet.</p> - <span class="summary_desc"><div class='inline'> -<p>specifies if the cells that have the style containing this protection.</p> + <span class="summary_desc"><div class='inline'><p> +specifies if the cells that have the style containing this protection. +</p> </div></span> </li> @@ -207,8 +211,9 @@ spreadsheet.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a new CellProtection.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new CellProtection. +</p> </div></span> </li> @@ -230,8 +235,9 @@ spreadsheet.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the cell protection.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the cell protection. +</p> </div></span> </li> @@ -252,8 +258,9 @@ spreadsheet.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new CellProtection</p> + <p> +Creates a new CellProtection +</p> </div> @@ -274,8 +281,9 @@ spreadsheet.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -294,8 +302,9 @@ spreadsheet.</p> <span class="default"> </span> - — <div class='inline'> -<p>value for hidden protection</p> + — <div class='inline'><p> +value for hidden protection +</p> </div> </li> @@ -305,8 +314,9 @@ spreadsheet.</p> <span class="default"> </span> - — <div class='inline'> -<p>value for locked protection</p> + — <div class='inline'><p> +value for locked protection +</p> </div> </li> @@ -329,11 +339,12 @@ spreadsheet.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_protection.rb', line 18</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span> - <span class='kw'>end</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -356,8 +367,9 @@ spreadsheet.</p> </p><div class="docstring"> <div class="discussion"> - -<p>specifies locking for cells that have the style containing this protection</p> + <p> +specifies locking for cells that have the style containing this protection +</p> </div> @@ -391,9 +403,10 @@ spreadsheet.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_protection.rb', line 9</span> -<span class='kw'>def</span> <span class='id hidden'>hidden</span> - <span class='ivar'>@hidden</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='hidden identifier id'>hidden</span> + <span class='@hidden ivar id'>@hidden</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -411,8 +424,9 @@ spreadsheet.</p> </p><div class="docstring"> <div class="discussion"> - -<p>specifies if the cells that have the style containing this protection</p> + <p> +specifies if the cells that have the style containing this protection +</p> </div> @@ -446,9 +460,10 @@ spreadsheet.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_protection.rb', line 13</span> -<span class='kw'>def</span> <span class='id locked'>locked</span> - <span class='ivar'>@locked</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='locked identifier id'>locked</span> + <span class='@locked ivar id'>@locked</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -470,8 +485,9 @@ spreadsheet.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the cell protection</p> + <p> +Serializes the cell protection +</p> </div> @@ -490,8 +506,9 @@ spreadsheet.</p> — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -525,9 +542,10 @@ spreadsheet.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_protection.rb', line 32</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id protection'>protection</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id instance_values'>instance_values</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='protection identifier id'>protection</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -538,9 +556,9 @@ spreadsheet.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:40 2011 by + Generated on Sun Nov 27 18:05:16 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/CellStyle.html b/doc/Axlsx/CellStyle.html index 33981c3b..2006b15b 100644 --- a/doc/Axlsx/CellStyle.html +++ b/doc/Axlsx/CellStyle.html @@ -97,14 +97,16 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>Using Styles#add_style is the recommended way to manage cell styling.</p> + <div class='inline'><p> +Using Styles#add_style is the recommended way to manage cell styling. +</p> </div> </div> - -<p>CellStyle defines named styles that reference defined formatting records -and can be used in your worksheet.</p> +<p> +CellStyle defines named styles that reference defined formatting records +and can be used in your worksheet. +</p> </div> @@ -143,8 +145,9 @@ and can be used in your worksheet.</p> - <span class="summary_desc"><div class='inline'> -<p>The buildinId to use when this named style is applied.</p> + <span class="summary_desc"><div class='inline'><p> +The buildinId to use when this named style is applied. +</p> </div></span> </li> @@ -169,8 +172,9 @@ and can be used in your worksheet.</p> - <span class="summary_desc"><div class='inline'> -<p>Indicates that the build in style reference has been customized.</p> + <span class="summary_desc"><div class='inline'><p> +Indicates that the build in style reference has been customized. +</p> </div></span> </li> @@ -195,9 +199,10 @@ and can be used in your worksheet.</p> - <span class="summary_desc"><div class='inline'> -<p>Determines if this named style should show in the list of styles when using -excel.</p> + <span class="summary_desc"><div class='inline'><p> +Determines if this named style should show in the list of styles when using +excel. +</p> </div></span> </li> @@ -222,9 +227,10 @@ excel.</p> - <span class="summary_desc"><div class='inline'> -<p>Determines if this formatting is for an outline style, and what level of -the outline it is to be applied to.</p> + <span class="summary_desc"><div class='inline'><p> +Determines if this formatting is for an outline style, and what level of +the outline it is to be applied to. +</p> </div></span> </li> @@ -249,8 +255,9 @@ the outline it is to be applied to.</p> - <span class="summary_desc"><div class='inline'> -<p>The name of this cell style.</p> + <span class="summary_desc"><div class='inline'><p> +The name of this cell style. +</p> </div></span> </li> @@ -275,8 +282,9 @@ the outline it is to be applied to.</p> - <span class="summary_desc"><div class='inline'> -<p>The formatting record id this named style utilizes.</p> + <span class="summary_desc"><div class='inline'><p> +The formatting record id this named style utilizes. +</p> </div></span> </li> @@ -313,8 +321,9 @@ the outline it is to be applied to.</p> - <span class="summary_desc"><div class='inline'> -<p>Creats a new CellStyle object.</p> + <span class="summary_desc"><div class='inline'><p> +Creats a new CellStyle object. +</p> </div></span> </li> @@ -336,8 +345,9 @@ the outline it is to be applied to.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the cell style.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the cell style. +</p> </div></span> </li> @@ -358,8 +368,9 @@ the outline it is to be applied to.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creats a new CellStyle object</p> + <p> +Creats a new CellStyle object +</p> </div> @@ -380,8 +391,9 @@ the outline it is to be applied to.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -467,11 +479,12 @@ the outline it is to be applied to.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_style.rb', line 39</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> - <span class='kw'>end</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -494,8 +507,9 @@ the outline it is to be applied to.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The buildinId to use when this named style is applied</p> + <p> +The buildinId to use when this named style is applied +</p> </div> @@ -536,9 +550,10 @@ the outline it is to be applied to.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_style.rb', line 18</span> -<span class='kw'>def</span> <span class='id builtinId'>builtinId</span> - <span class='ivar'>@builtinId</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='builtinId identifier id'>builtinId</span> + <span class='@builtinId ivar id'>@builtinId</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -556,8 +571,9 @@ the outline it is to be applied to.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Indicates that the build in style reference has been customized.</p> + <p> +Indicates that the build in style reference has been customized. +</p> </div> @@ -591,9 +607,10 @@ the outline it is to be applied to.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_style.rb', line 30</span> -<span class='kw'>def</span> <span class='id customBuiltin'>customBuiltin</span> - <span class='ivar'>@customBuiltin</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='customBuiltin identifier id'>customBuiltin</span> + <span class='@customBuiltin ivar id'>@customBuiltin</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -611,9 +628,10 @@ the outline it is to be applied to.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Determines if this named style should show in the list of styles when using -excel</p> + <p> +Determines if this named style should show in the list of styles when using +excel +</p> </div> @@ -647,9 +665,10 @@ excel</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_style.rb', line 26</span> -<span class='kw'>def</span> <span class='id hidden'>hidden</span> - <span class='ivar'>@hidden</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='hidden identifier id'>hidden</span> + <span class='@hidden ivar id'>@hidden</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -667,9 +686,10 @@ excel</p> </p><div class="docstring"> <div class="discussion"> - -<p>Determines if this formatting is for an outline style, and what level of -the outline it is to be applied to.</p> + <p> +Determines if this formatting is for an outline style, and what level of +the outline it is to be applied to. +</p> </div> @@ -703,9 +723,10 @@ the outline it is to be applied to.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_style.rb', line 22</span> -<span class='kw'>def</span> <span class='id iLevel'>iLevel</span> - <span class='ivar'>@iLevel</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='iLevel identifier id'>iLevel</span> + <span class='@iLevel ivar id'>@iLevel</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -723,8 +744,9 @@ the outline it is to be applied to.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The name of this cell style</p> + <p> +The name of this cell style +</p> </div> @@ -758,9 +780,10 @@ the outline it is to be applied to.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_style.rb', line 8</span> -<span class='kw'>def</span> <span class='id name'>name</span> - <span class='ivar'>@name</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='name identifier id'>name</span> + <span class='@name ivar id'>@name</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -778,8 +801,9 @@ the outline it is to be applied to.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The formatting record id this named style utilizes</p> + <p> +The formatting record id this named style utilizes +</p> </div> @@ -820,9 +844,10 @@ the outline it is to be applied to.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_style.rb', line 13</span> -<span class='kw'>def</span> <span class='id xfId'>xfId</span> - <span class='ivar'>@xfId</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='xfId identifier id'>xfId</span> + <span class='@xfId ivar id'>@xfId</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -844,8 +869,9 @@ the outline it is to be applied to.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the cell style</p> + <p> +Serializes the cell style +</p> </div> @@ -864,8 +890,9 @@ the outline it is to be applied to.</p> — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -899,9 +926,10 @@ the outline it is to be applied to.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_style.rb', line 60</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id cellStyle'>cellStyle</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id instance_values'>instance_values</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='cellStyle identifier id'>cellStyle</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -912,9 +940,9 @@ the outline it is to be applied to.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:39 2011 by + Generated on Sun Nov 27 18:05:07 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/Chart.html b/doc/Axlsx/Chart.html index 77914e8a..28333626 100644 --- a/doc/Axlsx/Chart.html +++ b/doc/Axlsx/Chart.html @@ -97,14 +97,16 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>Worksheet#add_chart is the recommended way to create charts for your -worksheets.</p> + <div class='inline'><p> +Worksheet#add_chart is the recommended way to create charts for your +worksheets. +</p> </div> </div> - -<p>A Chart is the superclass for specific charts</p> +<p> +A Chart is the superclass for specific charts +</p> </div> @@ -147,8 +149,9 @@ worksheets.</p> - <span class="summary_desc"><div class='inline'> -<p>A reference to the graphic frame that owns this chart.</p> + <span class="summary_desc"><div class='inline'><p> +A reference to the graphic frame that owns this chart. +</p> </div></span> </li> @@ -173,8 +176,9 @@ worksheets.</p> - <span class="summary_desc"><div class='inline'> -<p>A collection of series objects that are applied to the chart.</p> + <span class="summary_desc"><div class='inline'><p> +A collection of series objects that are applied to the chart. +</p> </div></span> </li> @@ -199,8 +203,9 @@ worksheets.</p> - <span class="summary_desc"><div class='inline'> -<p>The type of series to use for this chart.</p> + <span class="summary_desc"><div class='inline'><p> +The type of series to use for this chart. +</p> </div></span> </li> @@ -225,8 +230,9 @@ worksheets.</p> - <span class="summary_desc"><div class='inline'> -<p>Show the legend in the chart.</p> + <span class="summary_desc"><div class='inline'><p> +Show the legend in the chart. +</p> </div></span> </li> @@ -251,8 +257,9 @@ worksheets.</p> - <span class="summary_desc"><div class='inline'> -<p>The style for the chart.</p> + <span class="summary_desc"><div class='inline'><p> +The style for the chart. +</p> </div></span> </li> @@ -277,8 +284,9 @@ worksheets.</p> - <span class="summary_desc"><div class='inline'> -<p>The title object for the chart.</p> + <span class="summary_desc"><div class='inline'><p> +The title object for the chart. +</p> </div></span> </li> @@ -303,8 +311,9 @@ worksheets.</p> - <span class="summary_desc"><div class='inline'> -<p>The 3D view properties for the chart.</p> + <span class="summary_desc"><div class='inline'><p> +The 3D view properties for the chart. +</p> </div></span> </li> @@ -339,8 +348,9 @@ worksheets.</p> - <span class="summary_desc"><div class='inline'> -<p>Adds a new series to the chart's series collection.</p> + <span class="summary_desc"><div class='inline'><p> +Adds a new series to the chart’s series collection. +</p> </div></span> </li> @@ -362,9 +372,10 @@ worksheets.</p> - <span class="summary_desc"><div class='inline'> -<p>This is a short cut method to set the end anchor position If you need finer -granularity in positioning use graphic_frame.anchor.to.colOff / rowOff.</p> + <span class="summary_desc"><div class='inline'><p> +This is a short cut method to set the end anchor position If you need finer +granularity in positioning use graphic_frame.anchor.to.colOff / rowOff. +</p> </div></span> </li> @@ -386,9 +397,10 @@ granularity in positioning use graphic_frame.anchor.to.colOff / rowOff.</p> - <span class="summary_desc"><div class='inline'> -<p>backwards compatibility to allow chart.to and chart.from access to anchor -markers.</p> + <span class="summary_desc"><div class='inline'><p> +backwards compatibility to allow chart.to and chart.from access to anchor +markers. +</p> </div></span> </li> @@ -410,8 +422,9 @@ markers.</p> - <span class="summary_desc"><div class='inline'> -<p>The index of this chart in the workbooks charts collection.</p> + <span class="summary_desc"><div class='inline'><p> +The index of this chart in the workbooks charts collection. +</p> </div></span> </li> @@ -435,8 +448,9 @@ markers.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a new chart object.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new chart object. +</p> </div></span> </li> @@ -458,8 +472,9 @@ markers.</p> - <span class="summary_desc"><div class='inline'> -<p>The part name for this chart.</p> + <span class="summary_desc"><div class='inline'><p> +The part name for this chart. +</p> </div></span> </li> @@ -481,10 +496,11 @@ markers.</p> - <span class="summary_desc"><div class='inline'> -<p>This is a short cut method to set the start anchor position If you need + <span class="summary_desc"><div class='inline'><p> +This is a short cut method to set the start anchor position If you need finer granularity in positioning use graphic_frame.anchor.from.colOff / -rowOff.</p> +rowOff. +</p> </div></span> </li> @@ -506,9 +522,10 @@ rowOff.</p> - <span class="summary_desc"><div class='inline'> -<p>backwards compatibility to allow chart.to and chart.from access to anchor -markers.</p> + <span class="summary_desc"><div class='inline'><p> +backwards compatibility to allow chart.to and chart.from access to anchor +markers. +</p> </div></span> </li> @@ -530,8 +547,9 @@ markers.</p> - <span class="summary_desc"><div class='inline'> -<p>Chart Serialization serializes the chart.</p> + <span class="summary_desc"><div class='inline'><p> +Chart Serialization serializes the chart. +</p> </div></span> </li> @@ -552,8 +570,9 @@ markers.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new chart object</p> + <p> +Creates a new chart object +</p> </div> @@ -572,8 +591,9 @@ markers.</p> — - <div class='inline'> -<p>The frame that holds this chart.</p> + <div class='inline'><p> +The frame that holds this chart. +</p> </div> </li> @@ -590,8 +610,9 @@ markers.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -653,8 +674,9 @@ markers.</p> — - <div class='inline'> -<p>the object that the method was called on</p> + <div class='inline'><p> +the object that the method was called on +</p> </div> </li> @@ -685,20 +707,21 @@ markers.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 44</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id frame'>frame</span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='ivar'>@style</span> <span class='op'>=</span> <span class='int'>2</span> - <span class='ivar'>@graphic_frame</span><span class='op'>=</span><span class='id frame'>frame</span> - <span class='ivar'>@graphic_frame</span><span class='period'>.</span><span class='id anchor'>anchor</span><span class='period'>.</span><span class='id drawing'>drawing</span><span class='period'>.</span><span class='id worksheet'>worksheet</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id charts'>charts</span> <span class='op'><<</span> <span class='kw'>self</span> - <span class='ivar'>@series</span> <span class='op'>=</span> <span class='const'>SimpleTypedList</span><span class='period'>.</span><span class='id new'>new</span> <span class='const'>Series</span> - <span class='ivar'>@show_legend</span> <span class='op'>=</span> <span class='kw'>true</span> - <span class='ivar'>@series_type</span> <span class='op'>=</span> <span class='const'>Series</span> - <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span> - <span class='kw'>end</span> - <span class='id start_at'>start_at</span><span class='lparen'>(</span><span class='op'>*</span><span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:start_at</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:start_at</span><span class='rbracket'>]</span> - <span class='id end_at'>end_at</span><span class='lparen'>(</span><span class='op'>*</span><span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:end_at</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:start_at</span><span class='rbracket'>]</span> - <span class='kw'>yield</span> <span class='kw'>self</span> <span class='kw'>if</span> <span class='id block_given?'>block_given?</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='frame identifier id'>frame</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@style ivar id'>@style</span> <span class='assign token'>=</span> <span class='integer val'>2</span> + <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='assign token'>=</span><span class='frame identifier id'>frame</span> + <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='dot token'>.</span><span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='worksheet identifier id'>worksheet</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='charts identifier id'>charts</span> <span class='lshft op'><<</span> <span class='self self kw'>self</span> + <span class='@series ivar id'>@series</span> <span class='assign token'>=</span> <span class='SimpleTypedList constant id'>SimpleTypedList</span><span class='dot token'>.</span><span class='new identifier id'>new</span> <span class='Series constant id'>Series</span> + <span class='@show_legend ivar id'>@show_legend</span> <span class='assign token'>=</span> <span class='true true kw'>true</span> + <span class='@series_type ivar id'>@series_type</span> <span class='assign token'>=</span> <span class='Series constant id'>Series</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> + <span class='start_at identifier id'>start_at</span><span class='lparen token'>(</span><span class='mult op'>*</span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:start_at</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:start_at</span><span class='rbrack token'>]</span> + <span class='end_at identifier id'>end_at</span><span class='lparen token'>(</span><span class='mult op'>*</span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:end_at</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:start_at</span><span class='rbrack token'>]</span> + <span class='yield yield kw'>yield</span> <span class='self self kw'>self</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -721,8 +744,9 @@ markers.</p> </p><div class="docstring"> <div class="discussion"> - -<p>A reference to the graphic frame that owns this chart</p> + <p> +A reference to the graphic frame that owns this chart +</p> </div> @@ -756,9 +780,10 @@ markers.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 14</span> -<span class='kw'>def</span> <span class='id graphic_frame'>graphic_frame</span> - <span class='ivar'>@graphic_frame</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='graphic_frame identifier id'>graphic_frame</span> + <span class='@graphic_frame ivar id'>@graphic_frame</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -776,8 +801,9 @@ markers.</p> </p><div class="docstring"> <div class="discussion"> - -<p>A collection of series objects that are applied to the chart</p> + <p> +A collection of series objects that are applied to the chart +</p> </div> @@ -811,9 +837,10 @@ markers.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 18</span> -<span class='kw'>def</span> <span class='id series'>series</span> - <span class='ivar'>@series</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='series identifier id'>series</span> + <span class='@series ivar id'>@series</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -831,8 +858,9 @@ markers.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The type of series to use for this chart.</p> + <p> +The type of series to use for this chart. +</p> </div> @@ -866,9 +894,10 @@ markers.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 22</span> -<span class='kw'>def</span> <span class='id series_type'>series_type</span> - <span class='ivar'>@series_type</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='series_type identifier id'>series_type</span> + <span class='@series_type ivar id'>@series_type</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -886,8 +915,9 @@ markers.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Show the legend in the chart</p> + <p> +Show the legend in the chart +</p> </div> @@ -921,9 +951,10 @@ markers.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 38</span> -<span class='kw'>def</span> <span class='id show_legend'>show_legend</span> - <span class='ivar'>@show_legend</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='show_legend identifier id'>show_legend</span> + <span class='@show_legend ivar id'>@show_legend</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -941,8 +972,9 @@ markers.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The style for the chart. see ECMA Part 1 §21.2.2.196</p> + <p> +The style for the chart. see ECMA Part 1 §21.2.2.196 +</p> </div> @@ -976,9 +1008,10 @@ markers.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 34</span> -<span class='kw'>def</span> <span class='id style'>style</span> - <span class='ivar'>@style</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='style identifier id'>style</span> + <span class='@style ivar id'>@style</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -996,8 +1029,9 @@ markers.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The title object for the chart.</p> + <p> +The title object for the chart. +</p> </div> @@ -1031,9 +1065,10 @@ markers.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 29</span> -<span class='kw'>def</span> <span class='id title'>title</span> - <span class='ivar'>@title</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='title identifier id'>title</span> + <span class='@title ivar id'>@title</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1051,8 +1086,9 @@ markers.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The 3D view properties for the chart</p> + <p> +The 3D view properties for the chart +</p> </div> @@ -1073,9 +1109,10 @@ markers.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 10</span> -<span class='kw'>def</span> <span class='id view3D'>view3D</span> - <span class='ivar'>@view3D</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='view3D identifier id'>view3D</span> + <span class='@view3D ivar id'>@view3D</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1097,8 +1134,9 @@ markers.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Adds a new series to the chart's series collection.</p> + <p> +Adds a new series to the chart’s series collection. +</p> </div> @@ -1140,10 +1178,11 @@ markers.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 106</span> -<span class='kw'>def</span> <span class='id add_series'>add_series</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='ivar'>@series_type</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> - <span class='ivar'>@series</span><span class='period'>.</span><span class='id last'>last</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='add_series identifier id'>add_series</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@series_type ivar id'>@series_type</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='@series ivar id'>@series</span><span class='dot token'>.</span><span class='last identifier id'>last</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1158,9 +1197,10 @@ markers.</p> </p><div class="docstring"> <div class="discussion"> - -<p>This is a short cut method to set the end anchor position If you need finer -granularity in positioning use graphic_frame.anchor.to.colOff / rowOff</p> + <p> +This is a short cut method to set the end anchor position If you need finer +granularity in positioning use graphic_frame.anchor.to.colOff / rowOff +</p> </div> @@ -1179,8 +1219,9 @@ granularity in positioning use graphic_frame.anchor.to.colOff / rowOff</p> — - <div class='inline'> -<p>The column</p> + <div class='inline'><p> +The column +</p> </div> </li> @@ -1195,8 +1236,9 @@ granularity in positioning use graphic_frame.anchor.to.colOff / rowOff</p> — - <div class='inline'> -<p>The row</p> + <div class='inline'><p> +The row +</p> </div> </li> @@ -1231,10 +1273,11 @@ granularity in positioning use graphic_frame.anchor.to.colOff / rowOff</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 154</span> -<span class='kw'>def</span> <span class='id end_at'>end_at</span><span class='lparen'>(</span><span class='id x'>x</span><span class='comma'>,</span> <span class='id y'>y</span><span class='rparen'>)</span> - <span class='ivar'>@graphic_frame</span><span class='period'>.</span><span class='id anchor'>anchor</span><span class='period'>.</span><span class='id to'>to</span><span class='period'>.</span><span class='id col'>col</span> <span class='op'>=</span> <span class='id x'>x</span> - <span class='ivar'>@graphic_frame</span><span class='period'>.</span><span class='id anchor'>anchor</span><span class='period'>.</span><span class='id to'>to</span><span class='period'>.</span><span class='id row'>row</span> <span class='op'>=</span> <span class='id y'>y</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='end_at identifier id'>end_at</span><span class='lparen token'>(</span><span class='x identifier id'>x</span><span class='comma token'>,</span> <span class='y identifier id'>y</span><span class='rparen token'>)</span> + <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='dot token'>.</span><span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='to identifier id'>to</span><span class='dot token'>.</span><span class='col identifier id'>col</span> <span class='assign token'>=</span> <span class='x identifier id'>x</span> + <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='dot token'>.</span><span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='to identifier id'>to</span><span class='dot token'>.</span><span class='row identifier id'>row</span> <span class='assign token'>=</span> <span class='y identifier id'>y</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1252,14 +1295,16 @@ granularity in positioning use graphic_frame.anchor.to.colOff / rowOff</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>This will be disconinued in version 2.0.0. please use the start_at method</p> + <div class='inline'><p> +This will be disconinued in version 2.0.0. please use the start_at method +</p> </div> </div> - -<p>backwards compatibility to allow chart.to and chart.from access to anchor -markers</p> +<p> +backwards compatibility to allow chart.to and chart.from access to anchor +markers +</p> </div> @@ -1280,9 +1325,10 @@ markers</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 99</span> -<span class='kw'>def</span> <span class='id from'>from</span> - <span class='ivar'>@graphic_frame</span><span class='period'>.</span><span class='id anchor'>anchor</span><span class='period'>.</span><span class='id from'>from</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='from identifier id'>from</span> + <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='dot token'>.</span><span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='from identifier id'>from</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1297,8 +1343,9 @@ markers</p> </p><div class="docstring"> <div class="discussion"> - -<p>The index of this chart in the workbooks charts collection</p> + <p> +The index of this chart in the workbooks charts collection +</p> </div> @@ -1332,9 +1379,10 @@ markers</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 61</span> -<span class='kw'>def</span> <span class='id index'>index</span> - <span class='ivar'>@graphic_frame</span><span class='period'>.</span><span class='id anchor'>anchor</span><span class='period'>.</span><span class='id drawing'>drawing</span><span class='period'>.</span><span class='id worksheet'>worksheet</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id charts'>charts</span><span class='period'>.</span><span class='id index'>index</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='index identifier id'>index</span> + <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='dot token'>.</span><span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='worksheet identifier id'>worksheet</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='charts identifier id'>charts</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1349,8 +1397,9 @@ markers</p> </p><div class="docstring"> <div class="discussion"> - -<p>The part name for this chart</p> + <p> +The part name for this chart +</p> </div> @@ -1384,9 +1433,10 @@ markers</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 67</span> -<span class='kw'>def</span> <span class='id pn'>pn</span> - <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'>CHART_PN</span> <span class='op'>%</span> <span class='lparen'>(</span><span class='id index'>index</span><span class='op'>+</span><span class='int'>1</span><span class='rparen'>)</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='pn identifier id'>pn</span> + <span class='dstring node'>"#{CHART_PN % (index+1)}"</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1401,10 +1451,11 @@ markers</p> </p><div class="docstring"> <div class="discussion"> - -<p>This is a short cut method to set the start anchor position If you need + <p> +This is a short cut method to set the start anchor position If you need finer granularity in positioning use graphic_frame.anchor.from.colOff / -rowOff</p> +rowOff +</p> </div> @@ -1423,8 +1474,9 @@ rowOff</p> — - <div class='inline'> -<p>The column</p> + <div class='inline'><p> +The column +</p> </div> </li> @@ -1439,8 +1491,9 @@ rowOff</p> — - <div class='inline'> -<p>The row</p> + <div class='inline'><p> +The row +</p> </div> </li> @@ -1475,10 +1528,11 @@ rowOff</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 143</span> -<span class='kw'>def</span> <span class='id start_at'>start_at</span><span class='lparen'>(</span><span class='id x'>x</span><span class='comma'>,</span> <span class='id y'>y</span><span class='rparen'>)</span> - <span class='ivar'>@graphic_frame</span><span class='period'>.</span><span class='id anchor'>anchor</span><span class='period'>.</span><span class='id from'>from</span><span class='period'>.</span><span class='id col'>col</span> <span class='op'>=</span> <span class='id x'>x</span> - <span class='ivar'>@graphic_frame</span><span class='period'>.</span><span class='id anchor'>anchor</span><span class='period'>.</span><span class='id from'>from</span><span class='period'>.</span><span class='id row'>row</span> <span class='op'>=</span> <span class='id y'>y</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='start_at identifier id'>start_at</span><span class='lparen token'>(</span><span class='x identifier id'>x</span><span class='comma token'>,</span> <span class='y identifier id'>y</span><span class='rparen token'>)</span> + <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='dot token'>.</span><span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='from identifier id'>from</span><span class='dot token'>.</span><span class='col identifier id'>col</span> <span class='assign token'>=</span> <span class='x identifier id'>x</span> + <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='dot token'>.</span><span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='from identifier id'>from</span><span class='dot token'>.</span><span class='row identifier id'>row</span> <span class='assign token'>=</span> <span class='y identifier id'>y</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1496,14 +1550,16 @@ rowOff</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>This will be disconinued in version 2.0.0. Please use the end_at method</p> + <div class='inline'><p> +This will be disconinued in version 2.0.0. Please use the end_at method +</p> </div> </div> - -<p>backwards compatibility to allow chart.to and chart.from access to anchor -markers</p> +<p> +backwards compatibility to allow chart.to and chart.from access to anchor +markers +</p> </div> @@ -1524,9 +1580,10 @@ markers</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 93</span> -<span class='kw'>def</span> <span class='id to'>to</span> - <span class='ivar'>@graphic_frame</span><span class='period'>.</span><span class='id anchor'>anchor</span><span class='period'>.</span><span class='id to'>to</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to identifier id'>to</span> + <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='dot token'>.</span><span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='to identifier id'>to</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1541,8 +1598,9 @@ markers</p> </p><div class="docstring"> <div class="discussion"> - -<p>Chart Serialization serializes the chart</p> + <p> +Chart Serialization serializes the chart +</p> </div> @@ -1583,29 +1641,30 @@ markers</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 113</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span> - <span class='id builder'>builder</span> <span class='op'>=</span> <span class='const'>Nokogiri</span><span class='op'>::</span><span class='const'>XML</span><span class='op'>::</span><span class='const'>Builder</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='symbol'>:encoding</span> <span class='op'>=></span> <span class='const'>ENCODING</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id xml'>xml</span><span class='op'>|</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:chartSpace</span><span class='tstring_end'>'</span></span><span class='comma'>,</span><span class='symbol'>:xmlns:c</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='const'>XML_NS_C</span><span class='comma'>,</span> <span class='symbol'>:xmlns:a</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='const'>XML_NS_A</span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:date1904</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Workbook</span><span class='period'>.</span><span class='id date1904'>date1904</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:style</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='id style'>style</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:chart</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='ivar'>@title</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@title</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='ivar'>@view3D</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@view3D</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:plotArea</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:layout</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> - <span class='kw'>yield</span> <span class='id xml'>xml</span> <span class='kw'>if</span> <span class='id block_given?'>block_given?</span> - <span class='rbrace'>}</span> - <span class='kw'>if</span> <span class='ivar'>@show_legend</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:legend</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:legendPos</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>r</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:layout</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> - <span class='rbrace'>}</span> - <span class='kw'>end</span> - <span class='rbrace'>}</span> - <span class='rbrace'>}</span> - <span class='kw'>end</span> - <span class='id builder'>builder</span><span class='period'>.</span><span class='id to_xml'>to_xml</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span> + <span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:chartSpace'</span><span class='comma token'>,</span><span class='symbol val'>:'xmlns:c'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS_C constant id'>XML_NS_C</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:a'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS_A constant id'>XML_NS_A</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:date1904'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Workbook constant id'>Workbook</span><span class='dot token'>.</span><span class='date1904 identifier id'>date1904</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:style'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='style identifier id'>style</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:chart'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='@title ivar id'>@title</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@title ivar id'>@title</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='@view3D ivar id'>@view3D</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@view3D ivar id'>@view3D</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:plotArea'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:layout'</span><span class='rparen token'>)</span> + <span class='yield yield kw'>yield</span> <span class='xml identifier id'>xml</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> + <span class='rbrace token'>}</span> + <span class='if if kw'>if</span> <span class='@show_legend ivar id'>@show_legend</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:legend'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:legendPos'</span><span class='comma token'>,</span> <span class='symbol val'>:val</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"r"</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:layout'</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1616,9 +1675,9 @@ markers</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:36 2011 by + Generated on Sun Nov 27 18:05:17 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/Color.html b/doc/Axlsx/Color.html index 30d44a38..5653b8ea 100644 --- a/doc/Axlsx/Color.html +++ b/doc/Axlsx/Color.html @@ -94,8 +94,9 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>The color class represents a color used for borders, fills an fonts</p> + <p> +The color class represents a color used for borders, fills an fonts +</p> </div> @@ -127,8 +128,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Determines if the color is system color dependant.</p> + <span class="summary_desc"><div class='inline'><p> +Determines if the color is system color dependant. +</p> </div></span> </li> @@ -153,8 +155,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The color as defined in rgb terms.</p> + <span class="summary_desc"><div class='inline'><p> +The color as defined in rgb terms. +</p> </div></span> </li> @@ -179,8 +182,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The tint value.</p> + <span class="summary_desc"><div class='inline'><p> +The tint value. +</p> </div></span> </li> @@ -217,8 +221,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Creates a new Color object.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new Color object. +</p> </div></span> </li> @@ -240,8 +245,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Serializes the color.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the color. +</p> </div></span> </li> @@ -262,8 +268,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new Color object</p> + <p> +Creates a new Color object +</p> </div> @@ -284,8 +291,9 @@ — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -345,12 +353,13 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/color.rb', line 34</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='ivar'>@rgb</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>FF000000</span><span class='tstring_end'>"</span></span> - <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> - <span class='kw'>end</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@rgb ivar id'>@rgb</span> <span class='assign token'>=</span> <span class='string val'>"FF000000"</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -373,8 +382,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Determines if the color is system color dependant</p> + <p> +Determines if the color is system color dependant +</p> </div> @@ -408,9 +418,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/color.rb', line 6</span> -<span class='kw'>def</span> <span class='id auto'>auto</span> - <span class='ivar'>@auto</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='auto identifier id'>auto</span> + <span class='@auto ivar id'>@auto</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -431,14 +442,16 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>rgb colors need to conform to ST_UnsignedIntHex. That basically means put -'FF' before you color</p> + <div class='inline'><p> +rgb colors need to conform to ST_UnsignedIntHex. That basically means put +‘FF’ before you color +</p> </div> </div> - -<p>The color as defined in rgb terms.</p> +<p> +The color as defined in rgb terms. +</p> </div> @@ -448,11 +461,13 @@ <div class="examples"> <h3>Examples:</h3> - <h4><div class='inline'> -<p>rgb colors</p> + <h4><div class='inline'><p> +rgb colors +</p> </div></h4> - <pre class="example code">"FF000000" is black -"FFFFFFFF" is white</pre> + <pre class="example code"><span class='string val'>"FF000000"</span> <span class='is identifier id'>is</span> <span class='black identifier id'>black</span> +<span class='string val'>"FFFFFFFF"</span> <span class='is identifier id'>is</span> <span class='white identifier id'>white</span> +</pre> </div> @@ -483,9 +498,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/color.rb', line 19</span> -<span class='kw'>def</span> <span class='id rgb'>rgb</span> - <span class='ivar'>@rgb</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='rgb identifier id'>rgb</span> + <span class='@rgb ivar id'>@rgb</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -506,13 +522,15 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>valid values are between -1.0 and 1.0</p> + <div class='inline'><p> +valid values are between -1.0 and 1.0 +</p> </div> </div> - -<p>The tint value.</p> +<p> +The tint value. +</p> </div> @@ -546,9 +564,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/color.rb', line 28</span> -<span class='kw'>def</span> <span class='id tint'>tint</span> - <span class='ivar'>@tint</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='tint identifier id'>tint</span> + <span class='@tint ivar id'>@tint</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -570,8 +589,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the color</p> + <p> +Serializes the color +</p> </div> @@ -590,8 +610,9 @@ — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -623,7 +644,8 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/color.rb', line 57</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> <span class='id xml'>xml</span><span class='period'>.</span><span class='id color'>color</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id instance_values'>instance_values</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='color identifier id'>color</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='rparen token'>)</span> <span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -634,9 +656,9 @@ </div> <div id="footer"> - Generated on Sat Nov 26 13:16:37 2011 by + Generated on Sun Nov 27 18:05:05 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/ContentType.html b/doc/Axlsx/ContentType.html index d0b1de57..93d99a54 100644 --- a/doc/Axlsx/ContentType.html +++ b/doc/Axlsx/ContentType.html @@ -96,9 +96,10 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>ContentTypes used in the package. This is automatcially managed by the -package package.</p> + <p> +ContentTypes used in the package. This is automatcially managed by the +package package. +</p> </div> @@ -149,8 +150,9 @@ package package.</p> - <span class="summary_desc"><div class='inline'> -<p>A new instance of ContentType.</p> + <span class="summary_desc"><div class='inline'><p> +A new instance of ContentType. +</p> </div></span> </li> @@ -172,8 +174,9 @@ package package.</p> - <span class="summary_desc"><div class='inline'> -<p>Generates the xml document for [Content_Types].xml.</p> + <span class="summary_desc"><div class='inline'><p> +Generates the xml document for [Content_Types].xml. +</p> </div></span> </li> @@ -199,8 +202,9 @@ package package.</p> </p><div class="docstring"> <div class="discussion"> - -<p>A new instance of ContentType</p> + <p> +A new instance of ContentType +</p> </div> @@ -221,9 +225,10 @@ package package.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/content_type.rb', line 8</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span> - <span class='kw'>super</span> <span class='lbracket'>[</span><span class='const'>Override</span><span class='comma'>,</span> <span class='const'>Default</span><span class='rbracket'>]</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span> + <span class='super super kw'>super</span> <span class='lbrack token'>[</span><span class='Override constant id'>Override</span><span class='comma token'>,</span> <span class='Default constant id'>Default</span><span class='rbrack token'>]</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -255,8 +260,9 @@ package package.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Generates the xml document for [Content_Types].xml</p> + <p> +Generates the xml document for [Content_Types].xml +</p> </div> @@ -274,8 +280,9 @@ package package.</p> — - <div class='inline'> -<p>The document as a string.</p> + <div class='inline'><p> +The document as a string. +</p> </div> </li> @@ -300,14 +307,15 @@ package package.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/content_type.rb', line 14</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='rparen'>)</span> - <span class='id builder'>builder</span> <span class='op'>=</span> <span class='const'>Nokogiri</span><span class='op'>::</span><span class='const'>XML</span><span class='op'>::</span><span class='const'>Builder</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='symbol'>:encoding</span> <span class='op'>=></span> <span class='const'>ENCODING</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id xml'>xml</span><span class='op'>|</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='const'>Types</span><span class='lparen'>(</span><span class='symbol'>:xmlns</span> <span class='op'>=></span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>XML_NS_T</span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id type'>type</span><span class='op'>|</span> <span class='id type'>type</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> <span class='rbrace'>}</span> - <span class='rbrace'>}</span> - <span class='kw'>end</span> - <span class='id builder'>builder</span><span class='period'>.</span><span class='id to_xml'>to_xml</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='rparen token'>)</span> + <span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='Types constant id'>Types</span><span class='lparen token'>(</span><span class='symbol val'>:xmlns</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='XML_NS_T constant id'>XML_NS_T</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='type identifier id'>type</span><span class='bitor op'>|</span> <span class='type identifier id'>type</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -318,9 +326,9 @@ package package.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:40 2011 by + Generated on Sun Nov 27 18:05:04 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/Core.html b/doc/Axlsx/Core.html index b64268ea..9cbb01f3 100644 --- a/doc/Axlsx/Core.html +++ b/doc/Axlsx/Core.html @@ -97,13 +97,15 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>Packages manage their own core object.</p> + <div class='inline'><p> +Packages manage their own core object. +</p> </div> </div> - -<p>The core object for the package.</p> +<p> +The core object for the package. +</p> </div> @@ -142,8 +144,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The author of the document.</p> + <span class="summary_desc"><div class='inline'><p> +The author of the document. +</p> </div></span> </li> @@ -180,8 +183,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Creates a new Core object.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new Core object. +</p> </div></span> </li> @@ -203,8 +207,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Serializes the core object.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the core object. +</p> </div></span> </li> @@ -225,8 +230,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new Core object.</p> + <p> +Creates a new Core object. +</p> </div> @@ -247,8 +253,9 @@ — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -287,9 +294,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/core.rb', line 12</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='ivar'>@creator</span> <span class='op'>=</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:creator</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>axlsx</span><span class='tstring_end'>'</span></span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@creator ivar id'>@creator</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:creator</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='string val'>'axlsx'</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -312,8 +320,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>The author of the document. By default this is 'axlsx'</p> + <p> +The author of the document. By default this is ‘axlsx’ +</p> </div> @@ -347,9 +356,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/core.rb', line 8</span> -<span class='kw'>def</span> <span class='id creator'>creator</span> - <span class='ivar'>@creator</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='creator identifier id'>creator</span> + <span class='@creator ivar id'>@creator</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -371,9 +381,10 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the core object. The created dcterms item is set to the current -time when this method is called.</p> + <p> +Serializes the core object. The created dcterms item is set to the current +time when this method is called. +</p> </div> @@ -419,21 +430,22 @@ time when this method is called.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/core.rb', line 18</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='rparen'>)</span> - <span class='id builder'>builder</span> <span class='op'>=</span> <span class='const'>Nokogiri</span><span class='op'>::</span><span class='const'>XML</span><span class='op'>::</span><span class='const'>Builder</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='symbol'>:encoding</span> <span class='op'>=></span> <span class='const'>ENCODING</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id xml'>xml</span><span class='op'>|</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>cp:coreProperties</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> - <span class='symbol'>:xmlns:cp</span><span class='tstring_end'>"</span></span> <span class='op'>=></span> <span class='const'>CORE_NS</span><span class='comma'>,</span> - <span class='symbol'>:xmlns:dc</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='const'>CORE_NS_DC</span><span class='comma'>,</span> - <span class='symbol'>:xmlns:dcmitype</span><span class='tstring_end'>'</span></span><span class='op'>=></span><span class='const'>CORE_NS_DCMIT</span><span class='comma'>,</span> - <span class='symbol'>:xmlns:dcterms</span><span class='tstring_end'>'</span></span><span class='op'>=></span><span class='const'>CORE_NS_DCT</span><span class='comma'>,</span> - <span class='symbol'>:xmlns:xsi</span><span class='tstring_end'>'</span></span><span class='op'>=></span><span class='const'>CORE_NS_XSI</span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>dc</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id creator'>creator</span> <span class='kw'>self</span><span class='period'>.</span><span class='id creator'>creator</span> - <span class='id xml'>xml</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>dcterms</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id created'>created</span> <span class='const'>Time</span><span class='period'>.</span><span class='id now'>now</span><span class='period'>.</span><span class='id strftime'>strftime</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>%Y-%m-%dT%H:%M:%S</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='symbol'>:xsi:type</span><span class='tstring_end'>'</span></span><span class='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>dcterms:W3CDTF</span><span class='tstring_end'>"</span></span> - <span class='id xml'>xml</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>cp</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id revision'>revision</span> <span class='int'>0</span> - <span class='rbrace'>}</span> - <span class='kw'>end</span> - <span class='id builder'>builder</span><span class='period'>.</span><span class='id to_xml'>to_xml</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='rparen token'>)</span> + <span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'cp:coreProperties'</span><span class='comma token'>,</span> + <span class='symbol val'>:"xmlns:cp"</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='CORE_NS constant id'>CORE_NS</span><span class='comma token'>,</span> + <span class='symbol val'>:'xmlns:dc'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='CORE_NS_DC constant id'>CORE_NS_DC</span><span class='comma token'>,</span> + <span class='symbol val'>:'xmlns:dcmitype'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='CORE_NS_DCMIT constant id'>CORE_NS_DCMIT</span><span class='comma token'>,</span> + <span class='symbol val'>:'xmlns:dcterms'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='CORE_NS_DCT constant id'>CORE_NS_DCT</span><span class='comma token'>,</span> + <span class='symbol val'>:'xmlns:xsi'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='CORE_NS_XSI constant id'>CORE_NS_XSI</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='lbrack token'>[</span><span class='string val'>'dc'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='creator identifier id'>creator</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='creator identifier id'>creator</span> + <span class='xml identifier id'>xml</span><span class='lbrack token'>[</span><span class='string val'>'dcterms'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='created identifier id'>created</span> <span class='Time constant id'>Time</span><span class='dot token'>.</span><span class='now identifier id'>now</span><span class='dot token'>.</span><span class='strftime identifier id'>strftime</span><span class='lparen token'>(</span><span class='string val'>'%Y-%m-%dT%H:%M:%S'</span><span class='rparen token'>)</span><span class='comma token'>,</span> <span class='symbol val'>:'xsi:type'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='string val'>"dcterms:W3CDTF"</span> + <span class='xml identifier id'>xml</span><span class='lbrack token'>[</span><span class='string val'>'cp'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='revision identifier id'>revision</span> <span class='integer val'>0</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -444,9 +456,9 @@ time when this method is called.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:37 2011 by + Generated on Sun Nov 27 18:05:20 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/DataTypeValidator.html b/doc/Axlsx/DataTypeValidator.html index 51a6b741..9da38c77 100644 --- a/doc/Axlsx/DataTypeValidator.html +++ b/doc/Axlsx/DataTypeValidator.html @@ -94,10 +94,11 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>Validate that the class of the value provided is either an instance or the + <p> +Validate that the class of the value provided is either an instance or the class of the allowed types and that any specified additional validation -returns true.</p> +returns true. +</p> </div> @@ -134,8 +135,9 @@ returns true.</p> - <span class="summary_desc"><div class='inline'> -<p>Perform validation.</p> + <span class="summary_desc"><div class='inline'><p> +Perform validation. +</p> </div></span> </li> @@ -159,8 +161,9 @@ returns true.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Perform validation</p> + <p> +Perform validation +</p> </div> @@ -179,8 +182,9 @@ returns true.</p> — - <div class='inline'> -<p>The name of what is being validated. This is included in the error message</p> + <div class='inline'><p> +The name of what is being validated. This is included in the error message +</p> </div> </li> @@ -195,8 +199,9 @@ returns true.</p> — - <div class='inline'> -<p>A single class or array of classes that the value is validated against.</p> + <div class='inline'><p> +A single class or array of classes that the value is validated against. +</p> </div> </li> @@ -213,8 +218,9 @@ returns true.</p> — - <div class='inline'> -<p>Any block that must evaluate to true for the value to be valid</p> + <div class='inline'><p> +Any block that must evaluate to true for the value to be valid +</p> </div> </li> @@ -232,8 +238,9 @@ returns true.</p> — - <div class='inline'> -<p>true if validation succeeds.</p> + <div class='inline'><p> +true if validation succeeds. +</p> </div> </li> @@ -250,9 +257,10 @@ returns true.</p> — - <div class='inline'> -<p>Raised if the class of the value provided is not in the specified array of -types or the block passed returns false</p> + <div class='inline'><p> +Raised if the class of the value provided is not in the specified array of +types or the block passed returns false +</p> </div> </li> @@ -286,16 +294,17 @@ types or the block passed returns false</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 34</span> -<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id validate'>validate</span><span class='lparen'>(</span><span class='id name'>name</span><span class='comma'>,</span> <span class='id types'>types</span><span class='comma'>,</span> <span class='id v'>v</span><span class='comma'>,</span> <span class='id other'>other</span><span class='op'>=</span> <span class='id lambda'>lambda</span><span class='lbrace'>{</span><span class='op'>|</span><span class='id arg'>arg</span><span class='op'>|</span> <span class='kw'>true</span> <span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='id types'>types</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='id types'>types</span><span class='rbracket'>]</span> <span class='kw'>unless</span> <span class='id types'>types</span><span class='period'>.</span><span class='id is_a?'>is_a?</span> <span class='const'>Array</span> - <span class='id valid_type'>valid_type</span> <span class='op'>=</span> <span class='kw'>false</span> - <span class='kw'>if</span> <span class='id v'>v</span><span class='period'>.</span><span class='id class'>class</span> <span class='op'>==</span> <span class='const'>Class</span> - <span class='id types'>types</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id t'>t</span><span class='op'>|</span> <span class='id valid_type'>valid_type</span> <span class='op'>=</span> <span class='kw'>true</span> <span class='kw'>if</span> <span class='id v'>v</span><span class='period'>.</span><span class='id ancestors'>ancestors</span><span class='period'>.</span><span class='id include?'>include?</span><span class='lparen'>(</span><span class='id t'>t</span><span class='rparen'>)</span> <span class='rbrace'>}</span> - <span class='kw'>else</span> - <span class='id types'>types</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id t'>t</span><span class='op'>|</span> <span class='id valid_type'>valid_type</span> <span class='op'>=</span> <span class='kw'>true</span> <span class='kw'>if</span> <span class='id v'>v</span><span class='period'>.</span><span class='id is_a?'>is_a?</span><span class='lparen'>(</span><span class='id t'>t</span><span class='rparen'>)</span> <span class='rbrace'>}</span> - <span class='kw'>end</span> - <span class='id raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='lparen'>(</span><span class='const'>ERR_TYPE</span> <span class='op'>%</span> <span class='lbracket'>[</span><span class='id v'>v</span><span class='period'>.</span><span class='id inspect'>inspect</span><span class='comma'>,</span> <span class='id name'>name</span><span class='comma'>,</span> <span class='id types'>types</span><span class='period'>.</span><span class='id inspect'>inspect</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='lparen'>(</span><span class='id other'>other</span><span class='period'>.</span><span class='id call'>call</span><span class='lparen'>(</span><span class='id v'>v</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='id valid_type'>valid_type</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='types identifier id'>types</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='comma token'>,</span> <span class='other identifier id'>other</span><span class='assign token'>=</span> <span class='lambda identifier id'>lambda</span><span class='lbrace token'>{</span><span class='bitor op'>|</span><span class='arg identifier id'>arg</span><span class='bitor op'>|</span> <span class='true true kw'>true</span> <span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='types identifier id'>types</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='types identifier id'>types</span><span class='rbrack token'>]</span> <span class='unless unless_mod kw'>unless</span> <span class='types identifier id'>types</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span> <span class='Array constant id'>Array</span> + <span class='valid_type identifier id'>valid_type</span> <span class='assign token'>=</span> <span class='false false kw'>false</span> + <span class='if if kw'>if</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='class identifier id'>class</span> <span class='eq op'>==</span> <span class='Class constant id'>Class</span> + <span class='types identifier id'>types</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='t identifier id'>t</span><span class='bitor op'>|</span> <span class='valid_type identifier id'>valid_type</span> <span class='assign token'>=</span> <span class='true true kw'>true</span> <span class='if if_mod kw'>if</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='ancestors identifier id'>ancestors</span><span class='dot token'>.</span><span class='include? fid id'>include?</span><span class='lparen token'>(</span><span class='t identifier id'>t</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> + <span class='else else kw'>else</span> + <span class='types identifier id'>types</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='t identifier id'>t</span><span class='bitor op'>|</span> <span class='valid_type identifier id'>valid_type</span> <span class='assign token'>=</span> <span class='true true kw'>true</span> <span class='if if_mod kw'>if</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='t identifier id'>t</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='lparen token'>(</span><span class='ERR_TYPE constant id'>ERR_TYPE</span> <span class='mod op'>%</span> <span class='lbrack token'>[</span><span class='v identifier id'>v</span><span class='dot token'>.</span><span class='inspect identifier id'>inspect</span><span class='comma token'>,</span> <span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='types identifier id'>types</span><span class='dot token'>.</span><span class='inspect identifier id'>inspect</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='lparen token'>(</span><span class='other identifier id'>other</span><span class='dot token'>.</span><span class='call identifier id'>call</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> <span class='andop op'>&&</span> <span class='valid_type identifier id'>valid_type</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -306,9 +315,9 @@ types or the block passed returns false</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:37 2011 by + Generated on Sun Nov 27 18:05:05 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/Default.html b/doc/Axlsx/Default.html index cbba6fdd..850334c6 100644 --- a/doc/Axlsx/Default.html +++ b/doc/Axlsx/Default.html @@ -94,9 +94,10 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>An default content part. These parts are automatically created by for you -based on the content of your package.</p> + <p> +An default content part. These parts are automatically created by for you +based on the content of your package. +</p> </div> @@ -128,8 +129,9 @@ based on the content of your package.</p> - <span class="summary_desc"><div class='inline'> -<p>The type of content.</p> + <span class="summary_desc"><div class='inline'><p> +The type of content. +</p> </div></span> </li> @@ -154,8 +156,9 @@ based on the content of your package.</p> - <span class="summary_desc"><div class='inline'> -<p>The extension of the content type.</p> + <span class="summary_desc"><div class='inline'><p> +The extension of the content type. +</p> </div></span> </li> @@ -192,8 +195,9 @@ based on the content of your package.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a new Default object.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new Default object. +</p> </div></span> </li> @@ -215,8 +219,9 @@ based on the content of your package.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the object to xml.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the object to xml. +</p> </div></span> </li> @@ -237,8 +242,9 @@ based on the content of your package.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new Default object</p> + <p> +Creates a new Default object +</p> </div> @@ -259,8 +265,9 @@ based on the content of your package.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -305,9 +312,10 @@ based on the content of your package.</p> — - <div class='inline'> -<p>An argument error is raised if both Extension and ContentType are not -specified.</p> + <div class='inline'><p> +An argument error is raised if both Extension and ContentType are not +specified. +</p> </div> </li> @@ -330,12 +338,13 @@ specified.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/default.rb', line 17</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='id raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Extension and ContentType are required</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:Extension</span><span class='rbracket'>]</span> <span class='op'>&&</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:ContentType</span><span class='rbracket'>]</span> - <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span> - <span class='kw'>end</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='string val'>"Extension and ContentType are required"</span> <span class='unless unless_mod kw'>unless</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:Extension</span><span class='rbrack token'>]</span> <span class='andop op'>&&</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:ContentType</span><span class='rbrack token'>]</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -358,8 +367,9 @@ specified.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The type of content.</p> + <p> +The type of content. +</p> </div> @@ -393,9 +403,10 @@ specified.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/default.rb', line 11</span> -<span class='kw'>def</span> <span class='const'>ContentType</span> - <span class='ivar'>@ContentType</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='ContentType constant id'>ContentType</span> + <span class='@ContentType ivar id'>@ContentType</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -413,8 +424,9 @@ specified.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The extension of the content type.</p> + <p> +The extension of the content type. +</p> </div> @@ -448,9 +460,10 @@ specified.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/default.rb', line 7</span> -<span class='kw'>def</span> <span class='const'>Extension</span> - <span class='ivar'>@Extension</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='Extension constant id'>Extension</span> + <span class='@Extension ivar id'>@Extension</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -472,8 +485,9 @@ specified.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the object to xml</p> + <p> +Serializes the object to xml +</p> </div> @@ -492,8 +506,9 @@ specified.</p> — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -527,9 +542,10 @@ specified.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/default.rb', line 33</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='const'>Default</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id instance_values'>instance_values</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='Default constant id'>Default</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -540,9 +556,9 @@ specified.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:38 2011 by + Generated on Sun Nov 27 18:05:06 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/Drawing.html b/doc/Axlsx/Drawing.html index 80d5ca01..48fc3412 100644 --- a/doc/Axlsx/Drawing.html +++ b/doc/Axlsx/Drawing.html @@ -97,17 +97,19 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage drawings is to use the Worksheet.add_chart -method.</p> + <div class='inline'><p> +The recommended way to manage drawings is to use the Worksheet.add_chart +method. +</p> </div> </div> - -<p>A Drawing is a canvas for charts. Each worksheet has a single drawing that +<p> +A Drawing is a canvas for charts. Each worksheet has a single drawing that manages anchors. The anchors reference the charts via graphical frames. This is not a trivial relationship so please do follow the advice in the -note. see README for an example of how to create a chart.</p> +note. see README for an example of how to create a chart. +</p> </div> @@ -148,9 +150,10 @@ note. see README for an example of how to create a chart.</p> - <span class="summary_desc"><div class='inline'> -<p>A collection of anchors for this drawing only TwoCellAnchors are supported -in this version.</p> + <span class="summary_desc"><div class='inline'><p> +A collection of anchors for this drawing only TwoCellAnchors are supported +in this version. +</p> </div></span> </li> @@ -175,8 +178,9 @@ in this version.</p> - <span class="summary_desc"><div class='inline'> -<p>The worksheet that owns the drawing.</p> + <span class="summary_desc"><div class='inline'><p> +The worksheet that owns the drawing. +</p> </div></span> </li> @@ -211,8 +215,9 @@ in this version.</p> - <span class="summary_desc"><div class='inline'> -<p>Adds a chart to the drawing.</p> + <span class="summary_desc"><div class='inline'><p> +Adds a chart to the drawing. +</p> </div></span> </li> @@ -234,8 +239,9 @@ in this version.</p> - <span class="summary_desc"><div class='inline'> -<p>Adds an image to the chart.</p> + <span class="summary_desc"><div class='inline'><p> +Adds an image to the chart. +</p> </div></span> </li> @@ -257,8 +263,9 @@ in this version.</p> - <span class="summary_desc"><div class='inline'> -<p>An array of charts that are associated with this drawing's anchors.</p> + <span class="summary_desc"><div class='inline'><p> +An array of charts that are associated with this drawing’s anchors. +</p> </div></span> </li> @@ -280,8 +287,10 @@ in this version.</p> - <span class="summary_desc"><div class='inline'> -<p>An array of image objects that are associated with this drawing's anchors.</p> + <span class="summary_desc"><div class='inline'><p> +An array of image objects that are associated with this drawing’s +anchors. +</p> </div></span> </li> @@ -303,8 +312,10 @@ in this version.</p> - <span class="summary_desc"><div class='inline'> -<p>The index of this drawing in the owning workbooks's drawings collection.</p> + <span class="summary_desc"><div class='inline'><p> +The index of this drawing in the owning workbooks’s drawings +collection. +</p> </div></span> </li> @@ -328,8 +339,9 @@ in this version.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a new Drawing object.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new Drawing object. +</p> </div></span> </li> @@ -351,8 +363,9 @@ in this version.</p> - <span class="summary_desc"><div class='inline'> -<p>The part name for this drawing.</p> + <span class="summary_desc"><div class='inline'><p> +The part name for this drawing. +</p> </div></span> </li> @@ -374,8 +387,9 @@ in this version.</p> - <span class="summary_desc"><div class='inline'> -<p>The drawing's relationships.</p> + <span class="summary_desc"><div class='inline'><p> +The drawing’s relationships. +</p> </div></span> </li> @@ -397,8 +411,9 @@ in this version.</p> - <span class="summary_desc"><div class='inline'> -<p>The relational part name for this drawing.</p> + <span class="summary_desc"><div class='inline'><p> +The relational part name for this drawing. +</p> </div></span> </li> @@ -420,8 +435,9 @@ in this version.</p> - <span class="summary_desc"><div class='inline'> -<p>The relation reference id for this drawing.</p> + <span class="summary_desc"><div class='inline'><p> +The relation reference id for this drawing. +</p> </div></span> </li> @@ -443,8 +459,9 @@ in this version.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the drawing.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the drawing. +</p> </div></span> </li> @@ -465,8 +482,9 @@ in this version.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new Drawing object</p> + <p> +Creates a new Drawing object +</p> </div> @@ -485,8 +503,9 @@ in this version.</p> — - <div class='inline'> -<p>The worksheet that owns this drawing</p> + <div class='inline'><p> +The worksheet that owns this drawing +</p> </div> </li> @@ -510,12 +529,13 @@ in this version.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 52</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id worksheet'>worksheet</span><span class='rparen'>)</span> - <span class='const'>DataTypeValidator</span><span class='period'>.</span><span class='id validate'>validate</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Drawing.worksheet</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='const'>Worksheet</span><span class='comma'>,</span> <span class='id worksheet'>worksheet</span> - <span class='ivar'>@worksheet</span> <span class='op'>=</span> <span class='id worksheet'>worksheet</span> - <span class='ivar'>@worksheet</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id drawings'>drawings</span> <span class='op'><<</span> <span class='kw'>self</span> - <span class='ivar'>@anchors</span> <span class='op'>=</span> <span class='const'>SimpleTypedList</span><span class='period'>.</span><span class='id new'>new</span> <span class='lbracket'>[</span><span class='const'>TwoCellAnchor</span><span class='comma'>,</span> <span class='const'>OneCellAnchor</span><span class='rbracket'>]</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='worksheet identifier id'>worksheet</span><span class='rparen token'>)</span> + <span class='DataTypeValidator constant id'>DataTypeValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='string val'>"Drawing.worksheet"</span><span class='comma token'>,</span> <span class='Worksheet constant id'>Worksheet</span><span class='comma token'>,</span> <span class='worksheet identifier id'>worksheet</span> + <span class='@worksheet ivar id'>@worksheet</span> <span class='assign token'>=</span> <span class='worksheet identifier id'>worksheet</span> + <span class='@worksheet ivar id'>@worksheet</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='drawings identifier id'>drawings</span> <span class='lshft op'><<</span> <span class='self self kw'>self</span> + <span class='@anchors ivar id'>@anchors</span> <span class='assign token'>=</span> <span class='SimpleTypedList constant id'>SimpleTypedList</span><span class='dot token'>.</span><span class='new identifier id'>new</span> <span class='lbrack token'>[</span><span class='TwoCellAnchor constant id'>TwoCellAnchor</span><span class='comma token'>,</span> <span class='OneCellAnchor constant id'>OneCellAnchor</span><span class='rbrack token'>]</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -538,9 +558,10 @@ in this version.</p> </p><div class="docstring"> <div class="discussion"> - -<p>A collection of anchors for this drawing only TwoCellAnchors are supported -in this version</p> + <p> +A collection of anchors for this drawing only TwoCellAnchors are supported +in this version +</p> </div> @@ -574,9 +595,10 @@ in this version</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 48</span> -<span class='kw'>def</span> <span class='id anchors'>anchors</span> - <span class='ivar'>@anchors</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='anchors identifier id'>anchors</span> + <span class='@anchors ivar id'>@anchors</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -594,8 +616,9 @@ in this version</p> </p><div class="docstring"> <div class="discussion"> - -<p>The worksheet that owns the drawing</p> + <p> +The worksheet that owns the drawing +</p> </div> @@ -629,9 +652,10 @@ in this version</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 43</span> -<span class='kw'>def</span> <span class='id worksheet'>worksheet</span> - <span class='ivar'>@worksheet</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='worksheet identifier id'>worksheet</span> + <span class='@worksheet ivar id'>@worksheet</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -656,14 +680,16 @@ in this version</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage charts is to use Worksheet.add_chart. Please -refer to that method for documentation.</p> + <div class='inline'><p> +The recommended way to manage charts is to use Worksheet.add_chart. Please +refer to that method for documentation. +</p> </div> </div> - -<p>Adds a chart to the drawing.</p> +<p> +Adds a chart to the drawing. +</p> </div> @@ -692,10 +718,11 @@ refer to that method for documentation.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 70</span> -<span class='kw'>def</span> <span class='id add_chart'>add_chart</span><span class='lparen'>(</span><span class='id chart_type'>chart_type</span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='const'>TwoCellAnchor</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> - <span class='ivar'>@anchors</span><span class='period'>.</span><span class='id last'>last</span><span class='period'>.</span><span class='id add_chart'>add_chart</span><span class='lparen'>(</span><span class='id chart_type'>chart_type</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='chart_type identifier id'>chart_type</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='TwoCellAnchor constant id'>TwoCellAnchor</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='@anchors ivar id'>@anchors</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='chart_type identifier id'>chart_type</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -713,14 +740,16 @@ refer to that method for documentation.</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage images is to use Worksheet.add_image. Please -refer to that method for documentation.</p> + <div class='inline'><p> +The recommended way to manage images is to use Worksheet.add_image. Please +refer to that method for documentation. +</p> </div> </div> - -<p>Adds an image to the chart</p> +<p> +Adds an image to the chart +</p> </div> @@ -749,10 +778,11 @@ refer to that method for documentation.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 62</span> -<span class='kw'>def</span> <span class='id add_image'>add_image</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='const'>OneCellAnchor</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> - <span class='ivar'>@anchors</span><span class='period'>.</span><span class='id last'>last</span><span class='period'>.</span><span class='id object'>object</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='add_image identifier id'>add_image</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='OneCellAnchor constant id'>OneCellAnchor</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='@anchors ivar id'>@anchors</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='object identifier id'>object</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -767,8 +797,9 @@ refer to that method for documentation.</p> </p><div class="docstring"> <div class="discussion"> - -<p>An array of charts that are associated with this drawing's anchors</p> + <p> +An array of charts that are associated with this drawing’s anchors +</p> </div> @@ -803,10 +834,11 @@ refer to that method for documentation.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 77</span> -<span class='kw'>def</span> <span class='id charts'>charts</span> - <span class='id charts'>charts</span> <span class='op'>=</span> <span class='ivar'>@anchors</span><span class='period'>.</span><span class='id select'>select</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id a'>a</span><span class='op'>|</span> <span class='id a'>a</span><span class='period'>.</span><span class='id object'>object</span><span class='period'>.</span><span class='id is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>GraphicFrame</span><span class='rparen'>)</span> <span class='rbrace'>}</span> - <span class='id charts'>charts</span><span class='period'>.</span><span class='id map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id a'>a</span><span class='op'>|</span> <span class='id a'>a</span><span class='period'>.</span><span class='id object'>object</span><span class='period'>.</span><span class='id chart'>chart</span> <span class='rbrace'>}</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='charts identifier id'>charts</span> + <span class='charts identifier id'>charts</span> <span class='assign token'>=</span> <span class='@anchors ivar id'>@anchors</span><span class='dot token'>.</span><span class='select identifier id'>select</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='a identifier id'>a</span><span class='bitor op'>|</span> <span class='a identifier id'>a</span><span class='dot token'>.</span><span class='object identifier id'>object</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='GraphicFrame constant id'>GraphicFrame</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> + <span class='charts identifier id'>charts</span><span class='dot token'>.</span><span class='map identifier id'>map</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='a identifier id'>a</span><span class='bitor op'>|</span> <span class='a identifier id'>a</span><span class='dot token'>.</span><span class='object identifier id'>object</span><span class='dot token'>.</span><span class='chart identifier id'>chart</span> <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -821,8 +853,10 @@ refer to that method for documentation.</p> </p><div class="docstring"> <div class="discussion"> - -<p>An array of image objects that are associated with this drawing's anchors</p> + <p> +An array of image objects that are associated with this drawing’s +anchors +</p> </div> @@ -857,10 +891,11 @@ refer to that method for documentation.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 84</span> -<span class='kw'>def</span> <span class='id images'>images</span> - <span class='id images'>images</span> <span class='op'>=</span> <span class='ivar'>@anchors</span><span class='period'>.</span><span class='id select'>select</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id a'>a</span><span class='op'>|</span> <span class='id a'>a</span><span class='period'>.</span><span class='id object'>object</span><span class='period'>.</span><span class='id is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Pic</span><span class='rparen'>)</span> <span class='rbrace'>}</span> - <span class='id images'>images</span><span class='period'>.</span><span class='id map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id a'>a</span><span class='op'>|</span> <span class='id a'>a</span><span class='period'>.</span><span class='id object'>object</span> <span class='rbrace'>}</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='images identifier id'>images</span> + <span class='images identifier id'>images</span> <span class='assign token'>=</span> <span class='@anchors ivar id'>@anchors</span><span class='dot token'>.</span><span class='select identifier id'>select</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='a identifier id'>a</span><span class='bitor op'>|</span> <span class='a identifier id'>a</span><span class='dot token'>.</span><span class='object identifier id'>object</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Pic constant id'>Pic</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> + <span class='images identifier id'>images</span><span class='dot token'>.</span><span class='map identifier id'>map</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='a identifier id'>a</span><span class='bitor op'>|</span> <span class='a identifier id'>a</span><span class='dot token'>.</span><span class='object identifier id'>object</span> <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -875,8 +910,10 @@ refer to that method for documentation.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The index of this drawing in the owning workbooks's drawings collection.</p> + <p> +The index of this drawing in the owning workbooks’s drawings +collection. +</p> </div> @@ -910,9 +947,10 @@ refer to that method for documentation.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 91</span> -<span class='kw'>def</span> <span class='id index'>index</span> - <span class='ivar'>@worksheet</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id drawings'>drawings</span><span class='period'>.</span><span class='id index'>index</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='index identifier id'>index</span> + <span class='@worksheet ivar id'>@worksheet</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='drawings identifier id'>drawings</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -927,8 +965,9 @@ refer to that method for documentation.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The part name for this drawing</p> + <p> +The part name for this drawing +</p> </div> @@ -962,9 +1001,10 @@ refer to that method for documentation.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 103</span> -<span class='kw'>def</span> <span class='id pn'>pn</span> - <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'>DRAWING_PN</span> <span class='op'>%</span> <span class='lparen'>(</span><span class='id index'>index</span><span class='op'>+</span><span class='int'>1</span><span class='rparen'>)</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='pn identifier id'>pn</span> + <span class='dstring node'>"#{DRAWING_PN % (index+1)}"</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -979,8 +1019,9 @@ refer to that method for documentation.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The drawing's relationships.</p> + <p> +The drawing’s relationships. +</p> </div> @@ -1021,16 +1062,17 @@ refer to that method for documentation.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 115</span> -<span class='kw'>def</span> <span class='id relationships'>relationships</span> - <span class='id r'>r</span> <span class='op'>=</span> <span class='const'>Relationships</span><span class='period'>.</span><span class='id new'>new</span> - <span class='id charts'>charts</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id chart'>chart</span><span class='op'>|</span> - <span class='id r'>r</span> <span class='op'><<</span> <span class='const'>Relationship</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='const'>CHART_R</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>../</span><span class='embexpr_beg'>#{</span><span class='id chart'>chart</span><span class='period'>.</span><span class='id pn'>pn</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> - <span class='kw'>end</span> - <span class='id images'>images</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id image'>image</span><span class='op'>|</span> - <span class='id r'>r</span> <span class='op'><<</span> <span class='const'>Relationship</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='const'>IMAGE_R</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>../</span><span class='embexpr_beg'>#{</span><span class='id image'>image</span><span class='period'>.</span><span class='id pn'>pn</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> - <span class='kw'>end</span> - <span class='id r'>r</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='relationships identifier id'>relationships</span> + <span class='r identifier id'>r</span> <span class='assign token'>=</span> <span class='Relationships constant id'>Relationships</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='charts identifier id'>charts</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='chart identifier id'>chart</span><span class='bitor op'>|</span> + <span class='r identifier id'>r</span> <span class='lshft op'><<</span> <span class='Relationship constant id'>Relationship</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='CHART_R constant id'>CHART_R</span><span class='comma token'>,</span> <span class='dstring node'>"../#{chart.pn}"</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> + <span class='images identifier id'>images</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='image identifier id'>image</span><span class='bitor op'>|</span> + <span class='r identifier id'>r</span> <span class='lshft op'><<</span> <span class='Relationship constant id'>Relationship</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='IMAGE_R constant id'>IMAGE_R</span><span class='comma token'>,</span> <span class='dstring node'>"../#{image.pn}"</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> + <span class='r identifier id'>r</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1045,8 +1087,9 @@ refer to that method for documentation.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The relational part name for this drawing</p> + <p> +The relational part name for this drawing +</p> </div> @@ -1080,9 +1123,10 @@ refer to that method for documentation.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 109</span> -<span class='kw'>def</span> <span class='id rels_pn'>rels_pn</span> - <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'>DRAWING_RELS_PN</span> <span class='op'>%</span> <span class='lparen'>(</span><span class='id index'>index</span><span class='op'>+</span><span class='int'>1</span><span class='rparen'>)</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='rels_pn identifier id'>rels_pn</span> + <span class='dstring node'>"#{DRAWING_RELS_PN % (index+1)}"</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1097,8 +1141,9 @@ refer to that method for documentation.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The relation reference id for this drawing</p> + <p> +The relation reference id for this drawing +</p> </div> @@ -1132,9 +1177,10 @@ refer to that method for documentation.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 97</span> -<span class='kw'>def</span> <span class='id rId'>rId</span> - <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>rId</span><span class='embexpr_beg'>#{</span><span class='id index'>index</span><span class='op'>+</span><span class='int'>1</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='rId identifier id'>rId</span> + <span class='dstring node'>"rId#{index+1}"</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1149,8 +1195,9 @@ refer to that method for documentation.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the drawing</p> + <p> +Serializes the drawing +</p> </div> @@ -1189,14 +1236,15 @@ refer to that method for documentation.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 128</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span> - <span class='id builder'>builder</span> <span class='op'>=</span> <span class='const'>Nokogiri</span><span class='op'>::</span><span class='const'>XML</span><span class='op'>::</span><span class='const'>Builder</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='symbol'>:encoding</span> <span class='op'>=></span> <span class='const'>ENCODING</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id xml'>xml</span><span class='op'>|</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>xdr:wsDr</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:xmlns:xdr</span><span class='tstring_end'>'</span></span><span class='op'>=></span><span class='const'>XML_NS_XDR</span><span class='comma'>,</span> <span class='symbol'>:xmlns:a</span><span class='tstring_end'>'</span></span><span class='op'>=></span><span class='const'>XML_NS_A</span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id anchors'>anchors</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id anchor'>anchor</span><span class='op'>|</span> <span class='id anchor'>anchor</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> <span class='rbrace'>}</span> - <span class='rbrace'>}</span> - <span class='kw'>end</span> - <span class='id builder'>builder</span><span class='period'>.</span><span class='id to_xml'>to_xml</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span> + <span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:wsDr'</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:xdr'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='XML_NS_XDR constant id'>XML_NS_XDR</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:a'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='XML_NS_A constant id'>XML_NS_A</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='anchors identifier id'>anchors</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span><span class='bitor op'>|</span><span class='anchor identifier id'>anchor</span><span class='bitor op'>|</span> <span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1207,9 +1255,9 @@ refer to that method for documentation.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:37 2011 by + Generated on Sun Nov 27 18:05:18 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/Fill.html b/doc/Axlsx/Fill.html index c7012232..3b3e1485 100644 --- a/doc/Axlsx/Fill.html +++ b/doc/Axlsx/Fill.html @@ -97,15 +97,17 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage styles in your workbook is to use -Styles#add_style.</p> + <div class='inline'><p> +The recommended way to manage styles in your workbook is to use +Styles#add_style. +</p> </div> </div> - -<p>The Fill is a formatting object that manages the background color, and -pattern for cells.</p> +<p> +The Fill is a formatting object that manages the background color, and +pattern for cells. +</p> </div> @@ -148,8 +150,9 @@ pattern for cells.</p> - <span class="summary_desc"><div class='inline'> -<p>The type of fill.</p> + <span class="summary_desc"><div class='inline'><p> +The type of fill. +</p> </div></span> </li> @@ -186,8 +189,9 @@ pattern for cells.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a new Fill object.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new Fill object. +</p> </div></span> </li> @@ -209,8 +213,9 @@ pattern for cells.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the fill.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the fill. +</p> </div></span> </li> @@ -231,8 +236,9 @@ pattern for cells.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new Fill object</p> + <p> +Creates a new Fill object +</p> </div> @@ -265,8 +271,9 @@ pattern for cells.</p> — - <div class='inline'> -<p>if the fill_type parameter is not a PatternFill or a GradientFill instance</p> + <div class='inline'><p> +if the fill_type parameter is not a PatternFill or a GradientFill instance +</p> </div> </li> @@ -286,9 +293,10 @@ pattern for cells.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/fill.rb', line 16</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id fill_type'>fill_type</span><span class='rparen'>)</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id fill_type'>fill_type</span> <span class='op'>=</span> <span class='id fill_type'>fill_type</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='fill_type identifier id'>fill_type</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='fill_type identifier id'>fill_type</span> <span class='assign token'>=</span> <span class='fill_type identifier id'>fill_type</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -311,8 +319,9 @@ pattern for cells.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The type of fill</p> + <p> +The type of fill +</p> </div> @@ -346,9 +355,10 @@ pattern for cells.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/fill.rb', line 11</span> -<span class='kw'>def</span> <span class='id fill_type'>fill_type</span> - <span class='ivar'>@fill_type</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='fill_type identifier id'>fill_type</span> + <span class='@fill_type ivar id'>@fill_type</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -370,8 +380,9 @@ pattern for cells.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the fill</p> + <p> +Serializes the fill +</p> </div> @@ -390,8 +401,9 @@ pattern for cells.</p> — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -425,9 +437,10 @@ pattern for cells.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/fill.rb', line 23</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id fill'>fill</span> <span class='lbrace'>{</span> <span class='ivar'>@fill_type</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> <span class='rbrace'>}</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='fill identifier id'>fill</span> <span class='lbrace token'>{</span> <span class='@fill_type ivar id'>@fill_type</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -438,9 +451,9 @@ pattern for cells.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:37 2011 by + Generated on Sun Nov 27 18:05:06 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/Font.html b/doc/Axlsx/Font.html index 575eb462..349c3650 100644 --- a/doc/Axlsx/Font.html +++ b/doc/Axlsx/Font.html @@ -97,13 +97,15 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage fonts, and other styles is Styles#add_style</p> + <div class='inline'><p> +The recommended way to manage fonts, and other styles is Styles#add_style +</p> </div> </div> - -<p>The Font class details a font instance for use in styling cells.</p> +<p> +The Font class details a font instance for use in styling cells. +</p> </div> @@ -142,8 +144,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Indicates if the font should be rendered in <b>bold</b>.</p> + <span class="summary_desc"><div class='inline'><p> +Indicates if the font should be rendered in <b>bold</b>. +</p> </div></span> </li> @@ -168,8 +171,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The charset of the font.</p> + <span class="summary_desc"><div class='inline'><p> +The charset of the font. +</p> </div></span> </li> @@ -194,8 +198,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The color of the font.</p> + <span class="summary_desc"><div class='inline'><p> +The color of the font. +</p> </div></span> </li> @@ -220,8 +225,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Indicates if the font should be condensed.</p> + <span class="summary_desc"><div class='inline'><p> +Indicates if the font should be condensed. +</p> </div></span> </li> @@ -246,8 +252,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The font's extend property.</p> + <span class="summary_desc"><div class='inline'><p> +The font’s extend property. +</p> </div></span> </li> @@ -272,8 +279,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The font's family.</p> + <span class="summary_desc"><div class='inline'><p> +The font’s family. +</p> </div></span> </li> @@ -298,8 +306,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Indicates if the font should be rendered italicized.</p> + <span class="summary_desc"><div class='inline'><p> +Indicates if the font should be rendered italicized. +</p> </div></span> </li> @@ -324,8 +333,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The name of the font.</p> + <span class="summary_desc"><div class='inline'><p> +The name of the font. +</p> </div></span> </li> @@ -350,8 +360,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Indicates if the font should be rendered with an outline.</p> + <span class="summary_desc"><div class='inline'><p> +Indicates if the font should be rendered with an outline. +</p> </div></span> </li> @@ -376,8 +387,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Indicates if the font should be rendered with a shadow.</p> + <span class="summary_desc"><div class='inline'><p> +Indicates if the font should be rendered with a shadow. +</p> </div></span> </li> @@ -402,8 +414,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Indicates if the font should be rendered with a strikthrough.</p> + <span class="summary_desc"><div class='inline'><p> +Indicates if the font should be rendered with a strikthrough. +</p> </div></span> </li> @@ -428,8 +441,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The size of the font.</p> + <span class="summary_desc"><div class='inline'><p> +The size of the font. +</p> </div></span> </li> @@ -466,8 +480,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Creates a new Font.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new Font. +</p> </div></span> </li> @@ -489,8 +504,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Serializes the fill.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the fill. +</p> </div></span> </li> @@ -511,8 +527,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new Font</p> + <p> +Creates a new Font +</p> </div> @@ -533,8 +550,9 @@ — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -683,11 +701,12 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 98</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> - <span class='kw'>end</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -710,8 +729,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Indicates if the font should be rendered in <b>bold</b></p> + <p> +Indicates if the font should be rendered in <b>bold</b> +</p> </div> @@ -745,9 +765,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 50</span> -<span class='kw'>def</span> <span class='id b'>b</span> - <span class='ivar'>@b</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='b identifier id'>b</span> + <span class='@b ivar id'>@b</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -768,34 +789,37 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The following values are defined in the OOXML specification and are OS -dependant values</p> - -<pre class="code">0 ANSI_CHARSET -1 DEFAULT_CHARSET -2 SYMBOL_CHARSET -77 MAC_CHARSET -128 SHIFTJIS_CHARSET -129 HANGUL_CHARSET -130 JOHAB_CHARSET -134 GB2312_CHARSET -136 CHINESEBIG5_CHARSET -161 GREEK_CHARSET -162 TURKISH_CHARSET -163 VIETNAMESE_CHARSET -177 HEBREW_CHARSET -178 ARABIC_CHARSET -186 BALTIC_CHARSET -204 RUSSIAN_CHARSET -222 THAI_CHARSET -238 EASTEUROPE_CHARSET -255 OEM_CHARSET</pre> + <div class='inline'><p> +The following values are defined in the OOXML specification and are OS +dependant values +</p> +<pre class="code"> + <span class='integer val'>0</span> <span class='ANSI_CHARSET constant id'>ANSI_CHARSET</span> + <span class='integer val'>1</span> <span class='DEFAULT_CHARSET constant id'>DEFAULT_CHARSET</span> + <span class='integer val'>2</span> <span class='SYMBOL_CHARSET constant id'>SYMBOL_CHARSET</span> + <span class='integer val'>77</span> <span class='MAC_CHARSET constant id'>MAC_CHARSET</span> + <span class='integer val'>128</span> <span class='SHIFTJIS_CHARSET constant id'>SHIFTJIS_CHARSET</span> + <span class='integer val'>129</span> <span class='HANGUL_CHARSET constant id'>HANGUL_CHARSET</span> + <span class='integer val'>130</span> <span class='JOHAB_CHARSET constant id'>JOHAB_CHARSET</span> + <span class='integer val'>134</span> <span class='GB2312_CHARSET constant id'>GB2312_CHARSET</span> + <span class='integer val'>136</span> <span class='CHINESEBIG5_CHARSET constant id'>CHINESEBIG5_CHARSET</span> + <span class='integer val'>161</span> <span class='GREEK_CHARSET constant id'>GREEK_CHARSET</span> + <span class='integer val'>162</span> <span class='TURKISH_CHARSET constant id'>TURKISH_CHARSET</span> + <span class='integer val'>163</span> <span class='VIETNAMESE_CHARSET constant id'>VIETNAMESE_CHARSET</span> + <span class='integer val'>177</span> <span class='HEBREW_CHARSET constant id'>HEBREW_CHARSET</span> + <span class='integer val'>178</span> <span class='ARABIC_CHARSET constant id'>ARABIC_CHARSET</span> + <span class='integer val'>186</span> <span class='BALTIC_CHARSET constant id'>BALTIC_CHARSET</span> + <span class='integer val'>204</span> <span class='RUSSIAN_CHARSET constant id'>RUSSIAN_CHARSET</span> + <span class='integer val'>222</span> <span class='THAI_CHARSET constant id'>THAI_CHARSET</span> + <span class='integer val'>238</span> <span class='EASTEUROPE_CHARSET constant id'>EASTEUROPE_CHARSET</span> + <span class='integer val'>255</span> <span class='OEM_CHARSET constant id'>OEM_CHARSET</span> +</pre> </div> </div> - -<p>The charset of the font</p> +<p> +The charset of the font +</p> </div> @@ -829,9 +853,10 @@ dependant values</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 33</span> -<span class='kw'>def</span> <span class='id charset'>charset</span> - <span class='ivar'>@charset</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='charset identifier id'>charset</span> + <span class='@charset ivar id'>@charset</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -849,8 +874,9 @@ dependant values</p> </p><div class="docstring"> <div class="discussion"> - -<p>The color of the font</p> + <p> +The color of the font +</p> </div> @@ -884,9 +910,10 @@ dependant values</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 78</span> -<span class='kw'>def</span> <span class='id color'>color</span> - <span class='ivar'>@color</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='color identifier id'>color</span> + <span class='@color ivar id'>@color</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -904,8 +931,9 @@ dependant values</p> </p><div class="docstring"> <div class="discussion"> - -<p>Indicates if the font should be condensed</p> + <p> +Indicates if the font should be condensed +</p> </div> @@ -939,9 +967,10 @@ dependant values</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 70</span> -<span class='kw'>def</span> <span class='id condense'>condense</span> - <span class='ivar'>@condense</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='condense identifier id'>condense</span> + <span class='@condense ivar id'>@condense</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -959,8 +988,9 @@ dependant values</p> </p><div class="docstring"> <div class="discussion"> - -<p>The font's extend property</p> + <p> +The font’s extend property +</p> </div> @@ -994,9 +1024,10 @@ dependant values</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 74</span> -<span class='kw'>def</span> <span class='id extend'>extend</span> - <span class='ivar'>@extend</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='extend identifier id'>extend</span> + <span class='@extend ivar id'>@extend</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1017,21 +1048,24 @@ dependant values</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The following are defined OOXML specification</p> - -<pre class="code">0 Not applicable. -1 Roman -2 Swiss -3 Modern -4 Script -5 Decorative -6..14 Reserved for future use</pre> + <div class='inline'><p> +The following are defined OOXML specification +</p> +<pre class="code"> + <span class='integer val'>0</span> <span class='Not constant id'>Not</span> <span class='applicable identifier id'>applicable</span><span class='dot token'>.</span> + <span class='integer val'>1</span> <span class='Roman constant id'>Roman</span> + <span class='integer val'>2</span> <span class='Swiss constant id'>Swiss</span> + <span class='integer val'>3</span> <span class='Modern constant id'>Modern</span> + <span class='integer val'>4</span> <span class='Script constant id'>Script</span> + <span class='integer val'>5</span> <span class='Decorative constant id'>Decorative</span> + <span class='float val'>6</span><span class='dot2 op'>..</span><span class='integer val'>14</span> <span class='Reserved constant id'>Reserved</span> <span class='for for kw'>for</span> <span class='future identifier id'>future</span> <span class='use identifier id'>use</span> +</pre> </div> </div> - -<p>The font's family</p> +<p> +The font’s family +</p> </div> @@ -1065,9 +1099,10 @@ dependant values</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 46</span> -<span class='kw'>def</span> <span class='id family'>family</span> - <span class='ivar'>@family</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='family identifier id'>family</span> + <span class='@family ivar id'>@family</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1085,8 +1120,9 @@ dependant values</p> </p><div class="docstring"> <div class="discussion"> - -<p>Indicates if the font should be rendered italicized</p> + <p> +Indicates if the font should be rendered italicized +</p> </div> @@ -1120,9 +1156,10 @@ dependant values</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 54</span> -<span class='kw'>def</span> <span class='id i'>i</span> - <span class='ivar'>@i</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='i identifier id'>i</span> + <span class='@i ivar id'>@i</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1140,8 +1177,9 @@ dependant values</p> </p><div class="docstring"> <div class="discussion"> - -<p>The name of the font</p> + <p> +The name of the font +</p> </div> @@ -1175,9 +1213,10 @@ dependant values</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 8</span> -<span class='kw'>def</span> <span class='id name'>name</span> - <span class='ivar'>@name</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='name identifier id'>name</span> + <span class='@name ivar id'>@name</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1195,8 +1234,9 @@ dependant values</p> </p><div class="docstring"> <div class="discussion"> - -<p>Indicates if the font should be rendered with an outline</p> + <p> +Indicates if the font should be rendered with an outline +</p> </div> @@ -1230,9 +1270,10 @@ dependant values</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 62</span> -<span class='kw'>def</span> <span class='id outline'>outline</span> - <span class='ivar'>@outline</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='outline identifier id'>outline</span> + <span class='@outline ivar id'>@outline</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1250,8 +1291,9 @@ dependant values</p> </p><div class="docstring"> <div class="discussion"> - -<p>Indicates if the font should be rendered with a shadow</p> + <p> +Indicates if the font should be rendered with a shadow +</p> </div> @@ -1285,9 +1327,10 @@ dependant values</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 66</span> -<span class='kw'>def</span> <span class='id shadow'>shadow</span> - <span class='ivar'>@shadow</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='shadow identifier id'>shadow</span> + <span class='@shadow ivar id'>@shadow</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1305,8 +1348,9 @@ dependant values</p> </p><div class="docstring"> <div class="discussion"> - -<p>Indicates if the font should be rendered with a strikthrough</p> + <p> +Indicates if the font should be rendered with a strikthrough +</p> </div> @@ -1340,9 +1384,10 @@ dependant values</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 58</span> -<span class='kw'>def</span> <span class='id strike'>strike</span> - <span class='ivar'>@strike</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='strike identifier id'>strike</span> + <span class='@strike ivar id'>@strike</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1360,8 +1405,9 @@ dependant values</p> </p><div class="docstring"> <div class="discussion"> - -<p>The size of the font.</p> + <p> +The size of the font. +</p> </div> @@ -1395,9 +1441,10 @@ dependant values</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 82</span> -<span class='kw'>def</span> <span class='id sz'>sz</span> - <span class='ivar'>@sz</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='sz identifier id'>sz</span> + <span class='@sz ivar id'>@sz</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1419,8 +1466,9 @@ dependant values</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the fill</p> + <p> +Serializes the fill +</p> </div> @@ -1439,8 +1487,9 @@ dependant values</p> — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -1478,13 +1527,14 @@ dependant values</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 131</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id font'>font</span> <span class='lbrace'>{</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id instance_values'>instance_values</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id k'>k</span><span class='comma'>,</span> <span class='id v'>v</span><span class='op'>|</span> - <span class='id v'>v</span><span class='period'>.</span><span class='id is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Color</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id v'>v</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='id k'>k</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='symbol'>:val</span> <span class='op'>=></span> <span class='id v'>v</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='kw'>end</span> - <span class='rbrace'>}</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='font identifier id'>font</span> <span class='lbrace token'>{</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='k identifier id'>k</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='bitor op'>|</span> + <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Color constant id'>Color</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='colon op'>:</span> <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='k identifier id'>k</span><span class='comma token'>,</span> <span class='lbrace token'>{</span><span class='symbol val'>:val</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='v identifier id'>v</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1495,9 +1545,9 @@ dependant values</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:37 2011 by + Generated on Sun Nov 27 18:05:06 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/GradientFill.html b/doc/Axlsx/GradientFill.html index 893cc360..8c1c6653 100644 --- a/doc/Axlsx/GradientFill.html +++ b/doc/Axlsx/GradientFill.html @@ -94,8 +94,9 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>A GradientFill defines the color and positioning for gradiant cell fill.</p> + <p> +A GradientFill defines the color and positioning for gradiant cell fill. +</p> </div> @@ -134,8 +135,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Percentage format bottom.</p> + <span class="summary_desc"><div class='inline'><p> +Percentage format bottom. +</p> </div></span> </li> @@ -160,8 +162,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Angle of the linear gradient.</p> + <span class="summary_desc"><div class='inline'><p> +Angle of the linear gradient. +</p> </div></span> </li> @@ -186,8 +189,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Percentage format left.</p> + <span class="summary_desc"><div class='inline'><p> +Percentage format left. +</p> </div></span> </li> @@ -212,8 +216,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Percentage format right.</p> + <span class="summary_desc"><div class='inline'><p> +Percentage format right. +</p> </div></span> </li> @@ -238,8 +243,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Collection of stop objects.</p> + <span class="summary_desc"><div class='inline'><p> +Collection of stop objects. +</p> </div></span> </li> @@ -264,8 +270,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Percentage format top.</p> + <span class="summary_desc"><div class='inline'><p> +Percentage format top. +</p> </div></span> </li> @@ -290,8 +297,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The type of gradient.</p> + <span class="summary_desc"><div class='inline'><p> +The type of gradient. +</p> </div></span> </li> @@ -328,8 +336,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Creates a new GradientFill object.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new GradientFill object. +</p> </div></span> </li> @@ -351,8 +360,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Serializes the gradientFill.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the gradientFill. +</p> </div></span> </li> @@ -373,8 +383,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new GradientFill object</p> + <p> +Creates a new GradientFill object +</p> </div> @@ -395,8 +406,9 @@ — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -484,13 +496,14 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 46</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span> <span class='op'>||=</span> <span class='symbol'>:linear</span> - <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> - <span class='kw'>end</span> - <span class='ivar'>@stop</span> <span class='op'>=</span> <span class='const'>SimpleTypedList</span><span class='period'>.</span><span class='id new'>new</span> <span class='const'>GradientStop</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:type</span><span class='rbrack token'>]</span> <span class='opasgn op'>||=</span> <span class='symbol val'>:linear</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> + <span class='@stop ivar id'>@stop</span> <span class='assign token'>=</span> <span class='SimpleTypedList constant id'>SimpleTypedList</span><span class='dot token'>.</span><span class='new identifier id'>new</span> <span class='GradientStop constant id'>GradientStop</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -513,8 +526,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Percentage format bottom</p> + <p> +Percentage format bottom +</p> </div> @@ -548,9 +562,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 33</span> -<span class='kw'>def</span> <span class='id bottom'>bottom</span> - <span class='ivar'>@bottom</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='bottom identifier id'>bottom</span> + <span class='@bottom ivar id'>@bottom</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -568,8 +583,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Angle of the linear gradient</p> + <p> +Angle of the linear gradient +</p> </div> @@ -603,9 +619,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 17</span> -<span class='kw'>def</span> <span class='id degree'>degree</span> - <span class='ivar'>@degree</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='degree identifier id'>degree</span> + <span class='@degree ivar id'>@degree</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -623,8 +640,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Percentage format left</p> + <p> +Percentage format left +</p> </div> @@ -658,9 +676,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 21</span> -<span class='kw'>def</span> <span class='id left'>left</span> - <span class='ivar'>@left</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='left identifier id'>left</span> + <span class='@left ivar id'>@left</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -678,8 +697,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Percentage format right</p> + <p> +Percentage format right +</p> </div> @@ -713,9 +733,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 25</span> -<span class='kw'>def</span> <span class='id right'>right</span> - <span class='ivar'>@right</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='right identifier id'>right</span> + <span class='@right ivar id'>@right</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -733,8 +754,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Collection of stop objects</p> + <p> +Collection of stop objects +</p> </div> @@ -768,9 +790,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 37</span> -<span class='kw'>def</span> <span class='id stop'>stop</span> - <span class='ivar'>@stop</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='stop identifier id'>stop</span> + <span class='@stop ivar id'>@stop</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -788,8 +811,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Percentage format top</p> + <p> +Percentage format top +</p> </div> @@ -823,9 +847,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 29</span> -<span class='kw'>def</span> <span class='id top'>top</span> - <span class='ivar'>@top</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='top identifier id'>top</span> + <span class='@top ivar id'>@top</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -846,16 +871,19 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>valid options are</p> - -<pre class="code"><span class='symbol'>:linear</span> -<span class='symbol'>:path</span></pre> + <div class='inline'><p> +valid options are +</p> +<pre class="code"> + <span class='symbol val'>:linear</span> + <span class='symbol val'>:path</span> +</pre> </div> </div> - -<p>The type of gradient.</p> +<p> +The type of gradient. +</p> </div> @@ -889,9 +917,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 13</span> -<span class='kw'>def</span> <span class='id type'>type</span> - <span class='ivar'>@type</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='type identifier id'>type</span> + <span class='@type ivar id'>@type</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -913,8 +942,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the gradientFill</p> + <p> +Serializes the gradientFill +</p> </div> @@ -933,8 +963,9 @@ — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -970,11 +1001,12 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 70</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id gradientFill'>gradientFill</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id instance_values'>instance_values</span><span class='period'>.</span><span class='id reject'>reject</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id k'>k</span><span class='comma'>,</span><span class='id v'>v</span><span class='op'>|</span> <span class='id k'>k</span><span class='period'>.</span><span class='id to_sym'>to_sym</span> <span class='op'>==</span> <span class='symbol'>:stop</span> <span class='rbrace'>}</span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='ivar'>@stop</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id s'>s</span><span class='op'>|</span> <span class='id s'>s</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> <span class='rbrace'>}</span> - <span class='rbrace'>}</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='gradientFill identifier id'>gradientFill</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='dot token'>.</span><span class='reject identifier id'>reject</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='k identifier id'>k</span><span class='comma token'>,</span><span class='v identifier id'>v</span><span class='bitor op'>|</span> <span class='k identifier id'>k</span><span class='dot token'>.</span><span class='to_sym identifier id'>to_sym</span> <span class='eq op'>==</span> <span class='symbol val'>:stop</span> <span class='rbrace token'>}</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='@stop ivar id'>@stop</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='s identifier id'>s</span><span class='bitor op'>|</span> <span class='s identifier id'>s</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -985,9 +1017,9 @@ </div> <div id="footer"> - Generated on Sat Nov 26 13:16:39 2011 by + Generated on Sun Nov 27 18:05:19 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/GradientStop.html b/doc/Axlsx/GradientStop.html index 405b6efd..baa08449 100644 --- a/doc/Axlsx/GradientStop.html +++ b/doc/Axlsx/GradientStop.html @@ -94,8 +94,9 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>The GradientStop object represents a color point in a gradient.</p> + <p> +The GradientStop object represents a color point in a gradient. +</p> </div> @@ -134,8 +135,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The color for this gradient stop.</p> + <span class="summary_desc"><div class='inline'><p> +The color for this gradient stop. +</p> </div></span> </li> @@ -160,8 +162,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The position of the color.</p> + <span class="summary_desc"><div class='inline'><p> +The position of the color. +</p> </div></span> </li> @@ -198,8 +201,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Creates a new GradientStop object.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new GradientStop object. +</p> </div></span> </li> @@ -221,8 +225,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Serializes the gradientStop.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the gradientStop. +</p> </div></span> </li> @@ -243,8 +248,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new GradientStop object</p> + <p> +Creates a new GradientStop object +</p> </div> @@ -292,10 +298,11 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_stop.rb', line 18</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id color'>color</span><span class='comma'>,</span> <span class='id position'>position</span><span class='rparen'>)</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id color'>color</span> <span class='op'>=</span> <span class='id color'>color</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id position'>position</span> <span class='op'>=</span> <span class='id position'>position</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='color identifier id'>color</span><span class='comma token'>,</span> <span class='position identifier id'>position</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='color identifier id'>color</span> <span class='assign token'>=</span> <span class='color identifier id'>color</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='position identifier id'>position</span> <span class='assign token'>=</span> <span class='position identifier id'>position</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -318,8 +325,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>The color for this gradient stop</p> + <p> +The color for this gradient stop +</p> </div> @@ -360,9 +368,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_stop.rb', line 9</span> -<span class='kw'>def</span> <span class='id color'>color</span> - <span class='ivar'>@color</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='color identifier id'>color</span> + <span class='@color ivar id'>@color</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -380,8 +389,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>The position of the color</p> + <p> +The position of the color +</p> </div> @@ -415,9 +425,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_stop.rb', line 13</span> -<span class='kw'>def</span> <span class='id position'>position</span> - <span class='ivar'>@position</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='position identifier id'>position</span> + <span class='@position ivar id'>@position</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -439,8 +450,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the gradientStop</p> + <p> +Serializes the gradientStop +</p> </div> @@ -459,8 +471,9 @@ — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -492,7 +505,8 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_stop.rb', line 31</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> <span class='id xml'>xml</span><span class='period'>.</span><span class='id stop'>stop</span><span class='lparen'>(</span><span class='symbol'>:position</span> <span class='op'>=></span> <span class='kw'>self</span><span class='period'>.</span><span class='id position'>position</span><span class='rparen'>)</span> <span class='lbrace'>{</span><span class='kw'>self</span><span class='period'>.</span><span class='id color'>color</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span><span class='rbrace'>}</span> <span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='stop identifier id'>stop</span><span class='lparen token'>(</span><span class='symbol val'>:position</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='position identifier id'>position</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='color identifier id'>color</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span><span class='rbrace token'>}</span> <span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -503,9 +517,9 @@ </div> <div id="footer"> - Generated on Sat Nov 26 13:16:39 2011 by + Generated on Sun Nov 27 18:05:02 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/GraphicFrame.html b/doc/Axlsx/GraphicFrame.html index 39c8949b..7db028a7 100644 --- a/doc/Axlsx/GraphicFrame.html +++ b/doc/Axlsx/GraphicFrame.html @@ -97,13 +97,15 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage charts is Worksheet#add_chart</p> + <div class='inline'><p> +The recommended way to manage charts is Worksheet#add_chart +</p> </div> </div> - -<p>A graphic frame defines a container for a chart object</p> +<p> +A graphic frame defines a container for a chart object +</p> </div> @@ -142,8 +144,9 @@ - <span class="summary_desc"><div class='inline'> -<p>A anchor that holds this frame.</p> + <span class="summary_desc"><div class='inline'><p> +A anchor that holds this frame. +</p> </div></span> </li> @@ -168,8 +171,9 @@ - <span class="summary_desc"><div class='inline'> -<p>A reference to the chart object associated with this frame.</p> + <span class="summary_desc"><div class='inline'><p> +A reference to the chart object associated with this frame. +</p> </div></span> </li> @@ -206,8 +210,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Creates a new GraphicFrame object.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new GraphicFrame object. +</p> </div></span> </li> @@ -229,8 +234,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The relationship id for this graphic.</p> + <span class="summary_desc"><div class='inline'><p> +The relationship id for this graphic. +</p> </div></span> </li> @@ -252,8 +258,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Serializes the graphic frame.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the graphic frame. +</p> </div></span> </li> @@ -274,8 +281,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new GraphicFrame object</p> + <p> +Creates a new GraphicFrame object +</p> </div> @@ -324,11 +332,12 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 18</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id anchor'>anchor</span><span class='comma'>,</span> <span class='id chart_type'>chart_type</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> - <span class='const'>DataTypeValidator</span><span class='period'>.</span><span class='id validate'>validate</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Drawing.chart_type</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='const'>Chart</span><span class='comma'>,</span> <span class='id chart_type'>chart_type</span> - <span class='ivar'>@anchor</span> <span class='op'>=</span> <span class='id anchor'>anchor</span> - <span class='ivar'>@chart</span> <span class='op'>=</span> <span class='id chart_type'>chart_type</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='anchor identifier id'>anchor</span><span class='comma token'>,</span> <span class='chart_type identifier id'>chart_type</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='DataTypeValidator constant id'>DataTypeValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='string val'>"Drawing.chart_type"</span><span class='comma token'>,</span> <span class='Chart constant id'>Chart</span><span class='comma token'>,</span> <span class='chart_type identifier id'>chart_type</span> + <span class='@anchor ivar id'>@anchor</span> <span class='assign token'>=</span> <span class='anchor identifier id'>anchor</span> + <span class='@chart ivar id'>@chart</span> <span class='assign token'>=</span> <span class='chart_type identifier id'>chart_type</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -351,8 +360,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>A anchor that holds this frame</p> + <p> +A anchor that holds this frame +</p> </div> @@ -386,9 +396,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 13</span> -<span class='kw'>def</span> <span class='id anchor'>anchor</span> - <span class='ivar'>@anchor</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='anchor identifier id'>anchor</span> + <span class='@anchor ivar id'>@anchor</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -406,8 +417,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>A reference to the chart object associated with this frame</p> + <p> +A reference to the chart object associated with this frame +</p> </div> @@ -441,9 +453,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 9</span> -<span class='kw'>def</span> <span class='id chart'>chart</span> - <span class='ivar'>@chart</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='chart identifier id'>chart</span> + <span class='@chart ivar id'>@chart</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -465,8 +478,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>The relationship id for this graphic</p> + <p> +The relationship id for this graphic +</p> </div> @@ -500,9 +514,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 26</span> -<span class='kw'>def</span> <span class='id rId'>rId</span> - <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>rId</span><span class='embexpr_beg'>#{</span><span class='ivar'>@anchor</span><span class='period'>.</span><span class='id index'>index</span><span class='op'>+</span><span class='int'>1</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='rId identifier id'>rId</span> + <span class='dstring node'>"rId#{@anchor.index+1}"</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -517,8 +532,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the graphic frame</p> + <p> +Serializes the graphic frame +</p> </div> @@ -537,8 +553,9 @@ — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -587,24 +604,25 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 33</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>xdr:graphicFrame</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>xdr:nvGraphicFramePr</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>xdr:cNvPr</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:id</span><span class='op'>=></span><span class='int'>2</span><span class='comma'>,</span> <span class='symbol'>:name</span><span class='op'>=></span><span class='id chart'>chart</span><span class='period'>.</span><span class='id title'>title</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>xdr:cNvGraphicFramePr</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> - <span class='rbrace'>}</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>xdr:xfrm</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>a:off</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:x</span><span class='op'>=></span><span class='int'>0</span><span class='comma'>,</span> <span class='symbol'>:y</span><span class='op'>=></span><span class='int'>0</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>a:ext</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:cx</span><span class='op'>=></span><span class='int'>0</span><span class='comma'>,</span> <span class='symbol'>:cy</span><span class='op'>=></span><span class='int'>0</span><span class='rparen'>)</span> - <span class='rbrace'>}</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>a:graphic</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>a:graphicData</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:uri</span><span class='op'>=></span><span class='const'>XML_NS_C</span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:chart</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:xmlns:c</span><span class='tstring_end'>'</span></span><span class='op'>=></span><span class='const'>XML_NS_C</span><span class='comma'>,</span> <span class='symbol'>:xmlns:r</span><span class='tstring_end'>'</span></span><span class='op'>=></span><span class='const'>XML_NS_R</span><span class='comma'>,</span> <span class='symbol'>:r:id</span><span class='tstring_end'>'</span></span><span class='op'>=></span><span class='id rId'>rId</span><span class='rparen'>)</span> - <span class='rbrace'>}</span> - <span class='rbrace'>}</span> - <span class='rbrace'>}</span> - -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:graphicFrame'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:nvGraphicFramePr'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:cNvPr'</span><span class='comma token'>,</span> <span class='symbol val'>:id=</span><span class='gt op'>></span><span class='integer val'>2</span><span class='comma token'>,</span> <span class='symbol val'>:name=</span><span class='gt op'>></span><span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='title identifier id'>title</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:cNvGraphicFramePr'</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:xfrm'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'a:off'</span><span class='comma token'>,</span> <span class='symbol val'>:x=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='comma token'>,</span> <span class='symbol val'>:y=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'a:ext'</span><span class='comma token'>,</span> <span class='symbol val'>:cx=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='comma token'>,</span> <span class='symbol val'>:cy=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'a:graphic'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'a:graphicData'</span><span class='comma token'>,</span> <span class='symbol val'>:uri=</span><span class='gt op'>></span><span class='XML_NS_C constant id'>XML_NS_C</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:chart'</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:c'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='XML_NS_C constant id'>XML_NS_C</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:r'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='XML_NS_R constant id'>XML_NS_R</span><span class='comma token'>,</span> <span class='symbol val'>:'r:id'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='rId identifier id'>rId</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -615,9 +633,9 @@ </div> <div id="footer"> - Generated on Sat Nov 26 13:16:38 2011 by + Generated on Sun Nov 27 18:05:10 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/Line3DChart.html b/doc/Axlsx/Line3DChart.html index cdb85a73..ee3c0e92 100644 --- a/doc/Axlsx/Line3DChart.html +++ b/doc/Axlsx/Line3DChart.html @@ -96,9 +96,10 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>The Line3DChart is a three dimentional line chart (who would have guessed?) -that you can add to your worksheet.</p> + <p> +The Line3DChart is a three dimentional line chart (who would have guessed?) +that you can add to your worksheet. +</p> </div> @@ -108,19 +109,21 @@ that you can add to your worksheet.</p> <div class="examples"> <h3>Examples:</h3> - <h4><div class='inline'> -<p>Creating a chart</p> + <h4><div class='inline'><p> +Creating a chart +</p> </div></h4> - <pre class="example code"><span class='comment'># This example creates a line in a single sheet. -</span><span class='id require'>require</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>rubygems</span><span class='tstring_end'>"</span></span> <span class='comment'># if that is your preferred way to manage gems! -</span><span class='id require'>require</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>axlsx</span><span class='tstring_end'>"</span></span> + <pre class="example code"><span class='comment val'># This example creates a line in a single sheet.</span> +<span class='require identifier id'>require</span> <span class='string val'>"rubygems"</span> <span class='comment val'># if that is your preferred way to manage gems!</span> +<span class='require identifier id'>require</span> <span class='string val'>"axlsx"</span> -<span class='id p'>p</span> <span class='op'>=</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span> -<span class='id ws'>ws</span> <span class='op'>=</span> <span class='id p'>p</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id add_worksheet'>add_worksheet</span> -<span class='id ws'>ws</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='symbol'>:values</span> <span class='op'>=></span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>This is a chart with no data in the sheet</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> +<span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> +<span class='ws identifier id'>ws</span> <span class='assign token'>=</span> <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> +<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"This is a chart with no data in the sheet"</span><span class='rbrack token'>]</span> -<span class='id chart'>chart</span> <span class='op'>=</span> <span class='id ws'>ws</span><span class='period'>.</span><span class='id add_chart'>add_chart</span><span class='lparen'>(</span><span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Line3DChart</span><span class='comma'>,</span> <span class='symbol'>:start_at</span><span class='op'>=></span> <span class='lbracket'>[</span><span class='int'>0</span><span class='comma'>,</span><span class='int'>1</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:end_at</span><span class='op'>=></span><span class='lbracket'>[</span><span class='int'>0</span><span class='comma'>,</span><span class='int'>6</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:title</span><span class='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Most Popular Pets</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> -<span class='id chart'>chart</span><span class='period'>.</span><span class='id add_series'>add_series</span> <span class='symbol'>:data</span> <span class='op'>=></span> <span class='lbracket'>[</span><span class='int'>1</span><span class='comma'>,</span> <span class='int'>9</span><span class='comma'>,</span> <span class='int'>10</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:labels</span> <span class='op'>=></span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Slimy Reptiles</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Fuzzy Bunnies</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Rottweiler</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span></pre> +<span class='chart identifier id'>chart</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Line3DChart constant id'>Line3DChart</span><span class='comma token'>,</span> <span class='symbol val'>:start_at=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:end_at=</span><span class='gt op'>></span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>6</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:title=</span><span class='gt op'>></span><span class='string val'>"Most Popular Pets"</span><span class='rparen token'>)</span> +<span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='add_series identifier id'>add_series</span> <span class='symbol val'>:data</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>9</span><span class='comma token'>,</span> <span class='integer val'>10</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:labels</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Slimy Reptiles"</span><span class='comma token'>,</span> <span class='string val'>"Fuzzy Bunnies"</span><span class='comma token'>,</span> <span class='string val'>"Rottweiler"</span><span class='rbrack token'>]</span> +</pre> </div> @@ -148,8 +151,9 @@ that you can add to your worksheet.</p> <dt id="GAP_AMOUNT_PERCENT-constant" class="">GAP_AMOUNT_PERCENT = <div class="docstring"> <div class="discussion"> - -<p>validation regex for gap amount percent</p> + <p> +validation regex for gap amount percent +</p> </div> @@ -159,7 +163,8 @@ that you can add to your worksheet.</p> </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>0*(([0-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)%</span><span class='regexp_end'>/</span></span></pre></dd> + <dd><pre class="code"><span class='regexp val'>/0*(([0-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)%/</span> +</pre></dd> </dl> @@ -191,8 +196,9 @@ that you can add to your worksheet.</p> - <span class="summary_desc"><div class='inline'> -<p>the category axis.</p> + <span class="summary_desc"><div class='inline'><p> +the category axis. +</p> </div></span> </li> @@ -217,9 +223,10 @@ that you can add to your worksheet.</p> - <span class="summary_desc"><div class='inline'> -<p>space between bar or column clusters, as a percentage of the bar or column -width.</p> + <span class="summary_desc"><div class='inline'><p> +space between bar or column clusters, as a percentage of the bar or column +width. +</p> </div></span> </li> @@ -244,8 +251,9 @@ width.</p> - <span class="summary_desc"><div class='inline'> -<p>grouping for a column, line, or area chart.</p> + <span class="summary_desc"><div class='inline'><p> +grouping for a column, line, or area chart. +</p> </div></span> </li> @@ -270,8 +278,9 @@ width.</p> - <span class="summary_desc"><div class='inline'> -<p>the category axis.</p> + <span class="summary_desc"><div class='inline'><p> +the category axis. +</p> </div></span> </li> @@ -296,8 +305,9 @@ width.</p> - <span class="summary_desc"><div class='inline'> -<p>the category axis.</p> + <span class="summary_desc"><div class='inline'><p> +the category axis. +</p> </div></span> </li> @@ -342,8 +352,9 @@ width.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a new line chart object.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new line chart object. +</p> </div></span> </li> @@ -365,8 +376,9 @@ width.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the bar chart.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the bar chart. +</p> </div></span> </li> @@ -397,8 +409,9 @@ width.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new line chart object</p> + <p> +Creates a new line chart object +</p> </div> @@ -417,8 +430,9 @@ width.</p> — - <div class='inline'> -<p>The workbook that owns this chart.</p> + <div class='inline'><p> +The workbook that owns this chart. +</p> </div> </li> @@ -435,8 +449,9 @@ width.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -577,19 +592,20 @@ width.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_3D_chart.rb', line 61</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id frame'>frame</span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='ivar'>@gapDepth</span> <span class='op'>=</span> <span class='kw'>nil</span> - <span class='ivar'>@grouping</span> <span class='op'>=</span> <span class='symbol'>:standard</span> - <span class='ivar'>@catAxId</span> <span class='op'>=</span> <span class='id rand'>rand</span><span class='lparen'>(</span><span class='int'>8</span> <span class='op'>**</span> <span class='int'>8</span><span class='rparen'>)</span> - <span class='ivar'>@valAxId</span> <span class='op'>=</span> <span class='id rand'>rand</span><span class='lparen'>(</span><span class='int'>8</span> <span class='op'>**</span> <span class='int'>8</span><span class='rparen'>)</span> - <span class='ivar'>@serAxId</span> <span class='op'>=</span> <span class='id rand'>rand</span><span class='lparen'>(</span><span class='int'>8</span> <span class='op'>**</span> <span class='int'>8</span><span class='rparen'>)</span> - <span class='ivar'>@catAxis</span> <span class='op'>=</span> <span class='const'>CatAxis</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='ivar'>@catAxId</span><span class='comma'>,</span> <span class='ivar'>@valAxId</span><span class='rparen'>)</span> - <span class='ivar'>@valAxis</span> <span class='op'>=</span> <span class='const'>ValAxis</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='ivar'>@valAxId</span><span class='comma'>,</span> <span class='ivar'>@catAxId</span><span class='rparen'>)</span> - <span class='ivar'>@serAxis</span> <span class='op'>=</span> <span class='const'>SerAxis</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='ivar'>@serAxId</span><span class='comma'>,</span> <span class='ivar'>@valAxId</span><span class='rparen'>)</span> - <span class='kw'>super</span><span class='lparen'>(</span><span class='id frame'>frame</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> - <span class='ivar'>@series_type</span> <span class='op'>=</span> <span class='const'>LineSeries</span> - <span class='ivar'>@view3D</span> <span class='op'>=</span> <span class='const'>View3D</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='symbol'>:perspective</span><span class='op'>=></span><span class='int'>30</span><span class='rbrace'>}</span><span class='period'>.</span><span class='id merge'>merge</span><span class='lparen'>(</span><span class='id options'>options</span><span class='rparen'>)</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='frame identifier id'>frame</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@gapDepth ivar id'>@gapDepth</span> <span class='assign token'>=</span> <span class='nil nil kw'>nil</span> + <span class='@grouping ivar id'>@grouping</span> <span class='assign token'>=</span> <span class='symbol val'>:standard</span> + <span class='@catAxId ivar id'>@catAxId</span> <span class='assign token'>=</span> <span class='rand identifier id'>rand</span><span class='lparen token'>(</span><span class='integer val'>8</span> <span class='pow op'>**</span> <span class='integer val'>8</span><span class='rparen token'>)</span> + <span class='@valAxId ivar id'>@valAxId</span> <span class='assign token'>=</span> <span class='rand identifier id'>rand</span><span class='lparen token'>(</span><span class='integer val'>8</span> <span class='pow op'>**</span> <span class='integer val'>8</span><span class='rparen token'>)</span> + <span class='@serAxId ivar id'>@serAxId</span> <span class='assign token'>=</span> <span class='rand identifier id'>rand</span><span class='lparen token'>(</span><span class='integer val'>8</span> <span class='pow op'>**</span> <span class='integer val'>8</span><span class='rparen token'>)</span> + <span class='@catAxis ivar id'>@catAxis</span> <span class='assign token'>=</span> <span class='CatAxis constant id'>CatAxis</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='@catAxId ivar id'>@catAxId</span><span class='comma token'>,</span> <span class='@valAxId ivar id'>@valAxId</span><span class='rparen token'>)</span> + <span class='@valAxis ivar id'>@valAxis</span> <span class='assign token'>=</span> <span class='ValAxis constant id'>ValAxis</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='@valAxId ivar id'>@valAxId</span><span class='comma token'>,</span> <span class='@catAxId ivar id'>@catAxId</span><span class='rparen token'>)</span> + <span class='@serAxis ivar id'>@serAxis</span> <span class='assign token'>=</span> <span class='SerAxis constant id'>SerAxis</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='@serAxId ivar id'>@serAxId</span><span class='comma token'>,</span> <span class='@valAxId ivar id'>@valAxId</span><span class='rparen token'>)</span> + <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='frame identifier id'>frame</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='@series_type ivar id'>@series_type</span> <span class='assign token'>=</span> <span class='LineSeries constant id'>LineSeries</span> + <span class='@view3D ivar id'>@view3D</span> <span class='assign token'>=</span> <span class='View3D constant id'>View3D</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='lbrace token'>{</span><span class='symbol val'>:perspective=</span><span class='gt op'>></span><span class='integer val'>30</span><span class='rbrace token'>}</span><span class='dot token'>.</span><span class='merge identifier id'>merge</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='rparen token'>)</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -612,8 +628,9 @@ width.</p> </p><div class="docstring"> <div class="discussion"> - -<p>the category axis</p> + <p> +the category axis +</p> </div> @@ -647,9 +664,10 @@ width.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_3D_chart.rb', line 25</span> -<span class='kw'>def</span> <span class='id catAxis'>catAxis</span> - <span class='ivar'>@catAxis</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='catAxis identifier id'>catAxis</span> + <span class='@catAxis ivar id'>@catAxis</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -667,9 +685,10 @@ width.</p> </p><div class="docstring"> <div class="discussion"> - -<p>space between bar or column clusters, as a percentage of the bar or column -width.</p> + <p> +space between bar or column clusters, as a percentage of the bar or column +width. +</p> </div> @@ -703,9 +722,10 @@ width.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_3D_chart.rb', line 37</span> -<span class='kw'>def</span> <span class='id gapDepth'>gapDepth</span> - <span class='ivar'>@gapDepth</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='gapDepth identifier id'>gapDepth</span> + <span class='@gapDepth ivar id'>@gapDepth</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -723,9 +743,10 @@ width.</p> </p><div class="docstring"> <div class="discussion"> - -<p>grouping for a column, line, or area chart. must be one of -[:percentStacked, :clustered, :standard, :stacked]</p> + <p> +grouping for a column, line, or area chart. must be one of +[:percentStacked, :clustered, :standard, :stacked] +</p> </div> @@ -759,9 +780,10 @@ width.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_3D_chart.rb', line 42</span> -<span class='kw'>def</span> <span class='id grouping'>grouping</span> - <span class='ivar'>@grouping</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='grouping identifier id'>grouping</span> + <span class='@grouping ivar id'>@grouping</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -779,8 +801,9 @@ width.</p> </p><div class="docstring"> <div class="discussion"> - -<p>the category axis</p> + <p> +the category axis +</p> </div> @@ -814,9 +837,10 @@ width.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_3D_chart.rb', line 33</span> -<span class='kw'>def</span> <span class='id serAxis'>serAxis</span> - <span class='ivar'>@serAxis</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='serAxis identifier id'>serAxis</span> + <span class='@serAxis ivar id'>@serAxis</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -834,8 +858,9 @@ width.</p> </p><div class="docstring"> <div class="discussion"> - -<p>the category axis</p> + <p> +the category axis +</p> </div> @@ -869,9 +894,10 @@ width.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_3D_chart.rb', line 29</span> -<span class='kw'>def</span> <span class='id valAxis'>valAxis</span> - <span class='ivar'>@valAxis</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='valAxis identifier id'>valAxis</span> + <span class='@valAxis ivar id'>@valAxis</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -893,8 +919,9 @@ width.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the bar chart</p> + <p> +Serializes the bar chart +</p> </div> @@ -941,22 +968,23 @@ width.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_3D_chart.rb', line 89</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span> - <span class='kw'>super</span><span class='lparen'>(</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id xml'>xml</span><span class='op'>|</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:line3DChart</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:grouping</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='id grouping'>grouping</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:varyColors</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='int'>1</span><span class='rparen'>)</span> - <span class='ivar'>@series</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id ser'>ser</span><span class='op'>|</span> <span class='id ser'>ser</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> <span class='rbrace'>}</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:gapDepth</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@gapDepth</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@gapDepth</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:axId</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@catAxId</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:axId</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@valAxId</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:axId</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@serAxId</span><span class='rparen'>)</span> - <span class='rbrace'>}</span> - <span class='ivar'>@catAxis</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='ivar'>@valAxis</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='ivar'>@serAxis</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='kw'>end</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span> + <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:line3DChart'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:grouping'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='grouping identifier id'>grouping</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:varyColors'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='integer val'>1</span><span class='rparen token'>)</span> + <span class='@series ivar id'>@series</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='ser identifier id'>ser</span><span class='bitor op'>|</span> <span class='ser identifier id'>ser</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:gapDepth'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@gapDepth ivar id'>@gapDepth</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@gapDepth ivar id'>@gapDepth</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:axId'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@catAxId ivar id'>@catAxId</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:axId'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@valAxId ivar id'>@valAxId</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:axId'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@serAxId ivar id'>@serAxId</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='@catAxis ivar id'>@catAxis</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='@valAxis ivar id'>@valAxis</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='@serAxis ivar id'>@serAxis</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -967,9 +995,9 @@ width.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:39 2011 by + Generated on Sun Nov 27 18:05:13 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/LineSeries.html b/doc/Axlsx/LineSeries.html index b2d75a69..a47310ed 100644 --- a/doc/Axlsx/LineSeries.html +++ b/doc/Axlsx/LineSeries.html @@ -99,13 +99,15 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage series is to use Chart#add_series</p> + <div class='inline'><p> +The recommended way to manage series is to use Chart#add_series +</p> </div> </div> - -<p>A LineSeries defines the title, data and labels for line charts</p> +<p> +A LineSeries defines the title, data and labels for line charts +</p> </div> @@ -150,8 +152,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The data for this series.</p> + <span class="summary_desc"><div class='inline'><p> +The data for this series. +</p> </div></span> </li> @@ -176,8 +179,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The labels for this series.</p> + <span class="summary_desc"><div class='inline'><p> +The labels for this series. +</p> </div></span> </li> @@ -222,8 +226,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Creates a new series.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new series. +</p> </div></span> </li> @@ -245,8 +250,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Serializes the series.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the series. +</p> </div></span> </li> @@ -277,8 +283,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new series</p> + <p> +Creates a new series +</p> </div> @@ -310,8 +317,9 @@ — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -364,12 +372,13 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_series.rb', line 20</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id chart'>chart</span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='ivar'>@labels</span><span class='comma'>,</span> <span class='ivar'>@data</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span> - <span class='kw'>super</span><span class='lparen'>(</span><span class='id chart'>chart</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> - <span class='ivar'>@labels</span> <span class='op'>=</span> <span class='const'>CatAxisData</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:labels</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:labels</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='ivar'>@data</span> <span class='op'>=</span> <span class='const'>ValAxisData</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:data</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:data</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='chart identifier id'>chart</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@labels ivar id'>@labels</span><span class='comma token'>,</span> <span class='@data ivar id'>@data</span> <span class='assign token'>=</span> <span class='nil nil kw'>nil</span><span class='comma token'>,</span> <span class='nil nil kw'>nil</span> + <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='chart identifier id'>chart</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='@labels ivar id'>@labels</span> <span class='assign token'>=</span> <span class='CatAxisData constant id'>CatAxisData</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:labels</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:labels</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='@data ivar id'>@data</span> <span class='assign token'>=</span> <span class='ValAxisData constant id'>ValAxisData</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:data</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:data</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -392,8 +401,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>The data for this series.</p> + <p> +The data for this series. +</p> </div> @@ -427,9 +437,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_series.rb', line 10</span> -<span class='kw'>def</span> <span class='id data'>data</span> - <span class='ivar'>@data</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='data identifier id'>data</span> + <span class='@data ivar id'>@data</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -447,8 +458,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>The labels for this series.</p> + <p> +The labels for this series. +</p> </div> @@ -482,9 +494,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_series.rb', line 14</span> -<span class='kw'>def</span> <span class='id labels'>labels</span> - <span class='ivar'>@labels</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='labels identifier id'>labels</span> + <span class='@labels ivar id'>@labels</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -506,8 +519,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the series</p> + <p> +Serializes the series +</p> </div> @@ -526,8 +540,9 @@ — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -564,12 +579,13 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_series.rb', line 30</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='kw'>super</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id xml_inner'>xml_inner</span><span class='op'>|</span> - <span class='ivar'>@labels</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml_inner'>xml_inner</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@labels</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='ivar'>@data</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml_inner'>xml_inner</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@data</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='kw'>end</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml_inner identifier id'>xml_inner</span><span class='bitor op'>|</span> + <span class='@labels ivar id'>@labels</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml_inner identifier id'>xml_inner</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@labels ivar id'>@labels</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='@data ivar id'>@data</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml_inner identifier id'>xml_inner</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@data ivar id'>@data</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -580,9 +596,9 @@ </div> <div id="footer"> - Generated on Sat Nov 26 13:16:38 2011 by + Generated on Sun Nov 27 18:05:05 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/Marker.html b/doc/Axlsx/Marker.html index e58b67ed..7153d97b 100644 --- a/doc/Axlsx/Marker.html +++ b/doc/Axlsx/Marker.html @@ -97,15 +97,17 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage markers is Worksheet#add_chart Markers are -created for a two cell anchor based on the :start and :end options.</p> + <div class='inline'><p> +The recommended way to manage markers is Worksheet#add_chart Markers are +created for a two cell anchor based on the :start and :end options. +</p> </div> </div> - -<p>The Marker class defines a point in the worksheet that drawing anchors -attach to.</p> +<p> +The Marker class defines a point in the worksheet that drawing anchors +attach to. +</p> </div> @@ -144,8 +146,9 @@ attach to.</p> - <span class="summary_desc"><div class='inline'> -<p>The column this marker anchors to.</p> + <span class="summary_desc"><div class='inline'><p> +The column this marker anchors to. +</p> </div></span> </li> @@ -170,8 +173,9 @@ attach to.</p> - <span class="summary_desc"><div class='inline'> -<p>The offset distance from this marker's column.</p> + <span class="summary_desc"><div class='inline'><p> +The offset distance from this marker’s column. +</p> </div></span> </li> @@ -196,8 +200,9 @@ attach to.</p> - <span class="summary_desc"><div class='inline'> -<p>The row this marker anchors to.</p> + <span class="summary_desc"><div class='inline'><p> +The row this marker anchors to. +</p> </div></span> </li> @@ -222,8 +227,9 @@ attach to.</p> - <span class="summary_desc"><div class='inline'> -<p>The offset distance from this marker's row.</p> + <span class="summary_desc"><div class='inline'><p> +The offset distance from this marker’s row. +</p> </div></span> </li> @@ -258,8 +264,9 @@ attach to.</p> - <span class="summary_desc"><div class='inline'> -<p>shortcut to set the column, row position for this marker.</p> + <span class="summary_desc"><div class='inline'><p> +shortcut to set the column, row position for this marker. +</p> </div></span> </li> @@ -283,8 +290,9 @@ attach to.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a new Marker object.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new Marker object. +</p> </div></span> </li> @@ -306,8 +314,9 @@ attach to.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the marker.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the marker. +</p> </div></span> </li> @@ -328,8 +337,9 @@ attach to.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new Marker object</p> + <p> +Creates a new Marker object +</p> </div> @@ -350,8 +360,9 @@ attach to.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -420,12 +431,13 @@ attach to.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 28</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='ivar'>@col</span><span class='comma'>,</span> <span class='ivar'>@colOff</span><span class='comma'>,</span> <span class='ivar'>@row</span><span class='comma'>,</span> <span class='ivar'>@rowOff</span> <span class='op'>=</span> <span class='int'>0</span><span class='comma'>,</span> <span class='int'>0</span><span class='comma'>,</span> <span class='int'>0</span><span class='comma'>,</span> <span class='int'>0</span> - <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> - <span class='kw'>end</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@col ivar id'>@col</span><span class='comma token'>,</span> <span class='@colOff ivar id'>@colOff</span><span class='comma token'>,</span> <span class='@row ivar id'>@row</span><span class='comma token'>,</span> <span class='@rowOff ivar id'>@rowOff</span> <span class='assign token'>=</span> <span class='integer val'>0</span><span class='comma token'>,</span> <span class='integer val'>0</span><span class='comma token'>,</span> <span class='integer val'>0</span><span class='comma token'>,</span> <span class='integer val'>0</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -448,8 +460,9 @@ attach to.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The column this marker anchors to</p> + <p> +The column this marker anchors to +</p> </div> @@ -483,9 +496,10 @@ attach to.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 9</span> -<span class='kw'>def</span> <span class='id col'>col</span> - <span class='ivar'>@col</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='col identifier id'>col</span> + <span class='@col ivar id'>@col</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -503,8 +517,9 @@ attach to.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The offset distance from this marker's column</p> + <p> +The offset distance from this marker’s column +</p> </div> @@ -538,9 +553,10 @@ attach to.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 13</span> -<span class='kw'>def</span> <span class='id colOff'>colOff</span> - <span class='ivar'>@colOff</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='colOff identifier id'>colOff</span> + <span class='@colOff ivar id'>@colOff</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -558,8 +574,9 @@ attach to.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The row this marker anchors to</p> + <p> +The row this marker anchors to +</p> </div> @@ -593,9 +610,10 @@ attach to.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 17</span> -<span class='kw'>def</span> <span class='id row'>row</span> - <span class='ivar'>@row</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='row identifier id'>row</span> + <span class='@row ivar id'>@row</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -613,8 +631,9 @@ attach to.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The offset distance from this marker's row</p> + <p> +The offset distance from this marker’s row +</p> </div> @@ -648,9 +667,10 @@ attach to.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 21</span> -<span class='kw'>def</span> <span class='id rowOff'>rowOff</span> - <span class='ivar'>@rowOff</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='rowOff identifier id'>rowOff</span> + <span class='@rowOff ivar id'>@rowOff</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -672,8 +692,9 @@ attach to.</p> </p><div class="docstring"> <div class="discussion"> - -<p>shortcut to set the column, row position for this marker</p> + <p> +shortcut to set the column, row position for this marker +</p> </div> @@ -692,8 +713,9 @@ attach to.</p> — - <div class='inline'> -<p>the column for the marker</p> + <div class='inline'><p> +the column for the marker +</p> </div> </li> @@ -708,8 +730,9 @@ attach to.</p> — - <div class='inline'> -<p>the row of the marker</p> + <div class='inline'><p> +the row of the marker +</p> </div> </li> @@ -731,10 +754,11 @@ attach to.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 47</span> -<span class='kw'>def</span> <span class='id coord'>coord</span><span class='lparen'>(</span><span class='id col'>col</span><span class='comma'>,</span> <span class='id row'>row</span><span class='rparen'>)</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id col'>col</span> <span class='op'>=</span> <span class='id col'>col</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id row'>row</span> <span class='op'>=</span> <span class='id row'>row</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='coord identifier id'>coord</span><span class='lparen token'>(</span><span class='col identifier id'>col</span><span class='comma token'>,</span> <span class='row identifier id'>row</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='col identifier id'>col</span> <span class='assign token'>=</span> <span class='col identifier id'>col</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='row identifier id'>row</span> <span class='assign token'>=</span> <span class='row identifier id'>row</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -749,8 +773,9 @@ attach to.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the marker</p> + <p> +Serializes the marker +</p> </div> @@ -769,8 +794,9 @@ attach to.</p> — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -806,11 +832,12 @@ attach to.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 54</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='lbracket'>[</span><span class='symbol'>:col</span><span class='comma'>,</span> <span class='symbol'>:colOff</span><span class='comma'>,</span> <span class='symbol'>:row</span><span class='comma'>,</span> <span class='symbol'>:rowOff</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id k'>k</span><span class='op'>|</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>xdr:</span><span class='embexpr_beg'>#{</span><span class='id k'>k</span><span class='period'>.</span><span class='id to_s'>to_s</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='id k'>k</span><span class='rparen'>)</span><span class='rparen'>)</span> - <span class='kw'>end</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='lbrack token'>[</span><span class='symbol val'>:col</span><span class='comma token'>,</span> <span class='symbol val'>:colOff</span><span class='comma token'>,</span> <span class='symbol val'>:row</span><span class='comma token'>,</span> <span class='symbol val'>:rowOff</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='k identifier id'>k</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"xdr:#{k.to_s}"</span><span class='comma token'>,</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='k identifier id'>k</span><span class='rparen token'>)</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -821,9 +848,9 @@ attach to.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:37 2011 by + Generated on Sun Nov 27 18:05:02 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/NumFmt.html b/doc/Axlsx/NumFmt.html index b308d6dc..51a18033 100644 --- a/doc/Axlsx/NumFmt.html +++ b/doc/Axlsx/NumFmt.html @@ -97,14 +97,16 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage styles is Styles#add_style</p> + <div class='inline'><p> +The recommended way to manage styles is Styles#add_style +</p> </div> </div> - -<p>A NumFmt object defines an identifier and formatting code for data in -cells.</p> +<p> +A NumFmt object defines an identifier and formatting code for data in +cells. +</p> </div> @@ -136,8 +138,9 @@ cells.</p> - <span class="summary_desc"><div class='inline'> -<p>The formatting to use for this number format.</p> + <span class="summary_desc"><div class='inline'><p> +The formatting to use for this number format. +</p> </div></span> </li> @@ -162,8 +165,9 @@ cells.</p> - <span class="summary_desc"><div class='inline'> -<p>An unsinged integer referencing a standard or custom number format.</p> + <span class="summary_desc"><div class='inline'><p> +An unsinged integer referencing a standard or custom number format. +</p> </div></span> </li> @@ -200,8 +204,9 @@ cells.</p> - <span class="summary_desc"><div class='inline'> -<p>A new instance of NumFmt.</p> + <span class="summary_desc"><div class='inline'><p> +A new instance of NumFmt. +</p> </div></span> </li> @@ -223,9 +228,10 @@ cells.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a numFmt element applying the instance values of this object as -attributes.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a numFmt element applying the instance values of this object as +attributes. +</p> </div></span> </li> @@ -246,8 +252,9 @@ attributes.</p> </p><div class="docstring"> <div class="discussion"> - -<p>A new instance of NumFmt</p> + <p> +A new instance of NumFmt +</p> </div> @@ -272,13 +279,14 @@ attributes.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/num_fmt.rb', line 45</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='ivar'>@numFmtId</span> <span class='op'>=</span> <span class='int'>0</span> - <span class='ivar'>@formatCode</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span> - <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> - <span class='kw'>end</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@numFmtId ivar id'>@numFmtId</span> <span class='assign token'>=</span> <span class='integer val'>0</span> + <span class='@formatCode ivar id'>@formatCode</span> <span class='assign token'>=</span> <span class='string val'>""</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -301,8 +309,9 @@ attributes.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The formatting to use for this number format.</p> + <p> +The formatting to use for this number format. +</p> </div> @@ -320,8 +329,9 @@ attributes.</p> — - <div class='inline'> -<p>The formatting to use for this number format.</p> + <div class='inline'><p> +The formatting to use for this number format. +</p> </div> </li> @@ -348,9 +358,10 @@ attributes.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/num_fmt.rb', line 44</span> -<span class='kw'>def</span> <span class='id formatCode'>formatCode</span> - <span class='ivar'>@formatCode</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='formatCode identifier id'>formatCode</span> + <span class='@formatCode ivar id'>@formatCode</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -371,48 +382,51 @@ attributes.</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>These are the known formats I can dig up. The constant NUM_FMT_PERCENT is + <div class='inline'><p> +These are the known formats I can dig up. The constant NUM_FMT_PERCENT is 9, and uses the default % formatting. Axlsx also defines a few formats for date and time that are commonly used in asia as NUM_FMT_YYYYMMDD and -NUM_FRM_YYYYMMDDHHMMSS.</p> - -<pre class="code">1 0 -2 0.00 -3 #,##0 -4 #,##0.00 -5 $#,##0_);($#,##0) -6 $#,##0_);[Red]($#,##0) -7 $#,##0.00_);($#,##0.00) -8 $#,##0.00_);[Red]($#,##0.00) -9 0% -10 0.00% -11 0.00E+00 -12 # ?/? -13 # ??/?? -14 m/d/yyyy -15 d-mmm-yy -16 d-mmm -17 mmm-yy -18 h:mm AM/PM -19 h:mm:ss AM/PM -20 h:mm -21 h:mm:ss -22 m/d/yyyy h:mm -37 #,##0_);(#,##0) -38 #,##0_);[Red](#,##0) -39 #,##0.00_);(#,##0.00) -40 #,##0.00_);[Red](#,##0.00) -45 mm:ss -46 [h]:mm:ss -47 mm:ss.0 -48 ##0.0E+0 -49 @</pre> +NUM_FRM_YYYYMMDDHHMMSS. +</p> +<pre class="code"> + <span class='integer val'>1</span> <span class='integer val'>0</span> + <span class='integer val'>2</span> <span class='integer val'>0</span><span class='integer val'>.00</span> + <span class='integer val'>3</span> <span class='comment val'>#,##0</span> + <span class='integer val'>4</span> <span class='comment val'>#,##0.00</span> + <span class='integer val'>5</span> $<span class='comment val'>#,##0_);($#,##0)</span> + <span class='integer val'>6</span> $<span class='comment val'>#,##0_);[Red]($#,##0)</span> + <span class='integer val'>7</span> $<span class='comment val'>#,##0.00_);($#,##0.00)</span> + <span class='integer val'>8</span> $<span class='comment val'>#,##0.00_);[Red]($#,##0.00)</span> + <span class='integer val'>9</span> <span class='integer val'>0</span><span class='mod op'>%</span> + <span class='integer val'>10</span> <span class='integer val'>0</span><span class='integer val'>.00</span><span class='mod op'>%</span> + <span class='integer val'>11</span> <span class='integer val'>0</span><span class='float val'>.00E+00</span> + <span class='integer val'>12</span> <span class='comment val'># ?/?</span> + <span class='integer val'>13</span> <span class='comment val'># ??/??</span> + <span class='integer val'>14</span> <span class='m identifier id'>m</span><span class='div op'>/</span><span class='d identifier id'>d</span><span class='div op'>/</span><span class='yyyy identifier id'>yyyy</span> + <span class='integer val'>15</span> <span class='d identifier id'>d</span><span class='minus op'>-</span><span class='mmm identifier id'>mmm</span><span class='minus op'>-</span><span class='yy identifier id'>yy</span> + <span class='integer val'>16</span> <span class='d identifier id'>d</span><span class='minus op'>-</span><span class='mmm identifier id'>mmm</span> + <span class='integer val'>17</span> <span class='mmm identifier id'>mmm</span><span class='minus op'>-</span><span class='yy identifier id'>yy</span> + <span class='integer val'>18</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span> <span class='AM constant id'>AM</span><span class='div op'>/</span><span class='PM constant id'>PM</span> + <span class='integer val'>19</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span><span class='symbol val'>:ss</span> <span class='AM constant id'>AM</span><span class='div op'>/</span><span class='PM constant id'>PM</span> + <span class='integer val'>20</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span> + <span class='integer val'>21</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span><span class='symbol val'>:ss</span> + <span class='integer val'>22</span> <span class='m identifier id'>m</span><span class='div op'>/</span><span class='d identifier id'>d</span><span class='div op'>/</span><span class='yyyy identifier id'>yyyy</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span> + <span class='integer val'>37</span> <span class='comment val'>#,##0_);(#,##0)</span> + <span class='integer val'>38</span> <span class='comment val'>#,##0_);[Red](#,##0)</span> + <span class='integer val'>39</span> <span class='comment val'>#,##0.00_);(#,##0.00)</span> + <span class='integer val'>40</span> <span class='comment val'>#,##0.00_);[Red](#,##0.00)</span> + <span class='integer val'>45</span> <span class='mm identifier id'>mm</span><span class='symbol val'>:ss</span> + <span class='integer val'>46</span> <span class='lbrack token'>[</span><span class='h identifier id'>h</span><span class='rbrack token'>]</span><span class='symbol val'>:mm</span><span class='symbol val'>:ss</span> + <span class='integer val'>47</span> <span class='mm identifier id'>mm</span><span class='symbol val'>:ss</span><span class='integer val'>.0</span> + <span class='integer val'>48</span> <span class='comment val'>##0.0E+0</span> + <span class='integer val'>49</span> @ +</pre> </div> </div> - -<p>An unsinged integer referencing a standard or custom number format.</p> +<p> +An unsinged integer referencing a standard or custom number format. +</p> </div> @@ -430,8 +444,9 @@ NUM_FRM_YYYYMMDDHHMMSS.</p> — - <div class='inline'> -<p>An unsinged integer referencing a standard or custom number format.</p> + <div class='inline'><p> +An unsinged integer referencing a standard or custom number format. +</p> </div> </li> @@ -458,9 +473,10 @@ NUM_FRM_YYYYMMDDHHMMSS.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/num_fmt.rb', line 40</span> -<span class='kw'>def</span> <span class='id numFmtId'>numFmtId</span> - <span class='ivar'>@numFmtId</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='numFmtId identifier id'>numFmtId</span> + <span class='@numFmtId ivar id'>@numFmtId</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -482,9 +498,10 @@ NUM_FRM_YYYYMMDDHHMMSS.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a numFmt element applying the instance values of this object as -attributes.</p> + <p> +Creates a numFmt element applying the instance values of this object as +attributes. +</p> </div> @@ -503,8 +520,9 @@ attributes.</p> — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -523,7 +541,8 @@ attributes.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/num_fmt.rb', line 60</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> <span class='id xml'>xml</span><span class='period'>.</span><span class='id numFmt'>numFmt</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id instance_values'>instance_values</span><span class='rparen'>)</span> <span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='numFmt identifier id'>numFmt</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='rparen token'>)</span> <span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -534,9 +553,9 @@ attributes.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:38 2011 by + Generated on Sun Nov 27 18:05:19 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/OneCellAnchor.html b/doc/Axlsx/OneCellAnchor.html index eaec6d92..2952035f 100644 --- a/doc/Axlsx/OneCellAnchor.html +++ b/doc/Axlsx/OneCellAnchor.html @@ -97,14 +97,16 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage drawings, images and charts is -Worksheet#add_chart or Worksheet#add_image.</p> + <div class='inline'><p> +The recommended way to manage drawings, images and charts is +Worksheet#add_chart or Worksheet#add_image. +</p> </div> </div> - -<p>This class details a single cell anchor for drawings.</p> +<p> +This class details a single cell anchor for drawings. +</p> </div> @@ -145,8 +147,9 @@ Worksheet#add_chart or Worksheet#add_image.</p> - <span class="summary_desc"><div class='inline'> -<p>The drawing that holds this anchor.</p> + <span class="summary_desc"><div class='inline'><p> +The drawing that holds this anchor. +</p> </div></span> </li> @@ -171,8 +174,9 @@ Worksheet#add_chart or Worksheet#add_image.</p> - <span class="summary_desc"><div class='inline'> -<p>A marker that defines the from cell anchor.</p> + <span class="summary_desc"><div class='inline'><p> +A marker that defines the from cell anchor. +</p> </div></span> </li> @@ -197,9 +201,10 @@ Worksheet#add_chart or Worksheet#add_image.</p> - <span class="summary_desc"><div class='inline'> -<p>the height of the graphic object in pixels this is converted to EMU at a 92 -ppi resolution.</p> + <span class="summary_desc"><div class='inline'><p> +the height of the graphic object in pixels this is converted to EMU at a 92 +ppi resolution. +</p> </div></span> </li> @@ -224,8 +229,9 @@ ppi resolution.</p> - <span class="summary_desc"><div class='inline'> -<p>The object this anchor hosts.</p> + <span class="summary_desc"><div class='inline'><p> +The object this anchor hosts. +</p> </div></span> </li> @@ -250,8 +256,9 @@ ppi resolution.</p> - <span class="summary_desc"><div class='inline'> -<p>the width of the graphic object in pixels.</p> + <span class="summary_desc"><div class='inline'><p> +the width of the graphic object in pixels. +</p> </div></span> </li> @@ -286,8 +293,9 @@ ppi resolution.</p> - <span class="summary_desc"><div class='inline'> -<p>The index of this anchor in the drawing.</p> + <span class="summary_desc"><div class='inline'><p> +The index of this anchor in the drawing. +</p> </div></span> </li> @@ -311,8 +319,9 @@ ppi resolution.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a new OneCellAnchor object and an Pic associated with it.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new OneCellAnchor object and an Pic associated with it. +</p> </div></span> </li> @@ -334,8 +343,9 @@ ppi resolution.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the anchor.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the anchor. +</p> </div></span> </li> @@ -356,8 +366,9 @@ ppi resolution.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new OneCellAnchor object and an Pic associated with it.</p> + <p> +Creates a new OneCellAnchor object and an Pic associated with it. +</p> </div> @@ -389,8 +400,9 @@ ppi resolution.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -411,8 +423,9 @@ ppi resolution.</p> <span class="default"> </span> - — <div class='inline'> -<p>the col, row to start at</p> + — <div class='inline'><p> +the col, row to start at +</p> </div> </li> @@ -440,8 +453,9 @@ ppi resolution.</p> <span class="default"> </span> - — <div class='inline'> -<p>the file location of the image you will render</p> + — <div class='inline'><p> +the file location of the image you will render +</p> </div> </li> @@ -451,8 +465,9 @@ ppi resolution.</p> <span class="default"> </span> - — <div class='inline'> -<p>the name attribute for the rendered image</p> + — <div class='inline'><p> +the name attribute for the rendered image +</p> </div> </li> @@ -462,8 +477,9 @@ ppi resolution.</p> <span class="default"> </span> - — <div class='inline'> -<p>the description of the image rendered</p> + — <div class='inline'><p> +the description of the image rendered +</p> </div> </li> @@ -492,17 +508,18 @@ ppi resolution.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/one_cell_anchor.rb', line 39</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id drawing'>drawing</span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='ivar'>@drawing</span> <span class='op'>=</span> <span class='id drawing'>drawing</span> - <span class='ivar'>@width</span> <span class='op'>=</span> <span class='int'>0</span> - <span class='ivar'>@height</span> <span class='op'>=</span> <span class='int'>0</span> - <span class='id drawing'>drawing</span><span class='period'>.</span><span class='id anchors'>anchors</span> <span class='op'><<</span> <span class='kw'>self</span> - <span class='ivar'>@from</span> <span class='op'>=</span> <span class='const'>Marker</span><span class='period'>.</span><span class='id new'>new</span> - <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span> - <span class='kw'>end</span> - <span class='ivar'>@object</span> <span class='op'>=</span> <span class='const'>Pic</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='drawing identifier id'>drawing</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@drawing ivar id'>@drawing</span> <span class='assign token'>=</span> <span class='drawing identifier id'>drawing</span> + <span class='@width ivar id'>@width</span> <span class='assign token'>=</span> <span class='integer val'>0</span> + <span class='@height ivar id'>@height</span> <span class='assign token'>=</span> <span class='integer val'>0</span> + <span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='anchors identifier id'>anchors</span> <span class='lshft op'><<</span> <span class='self self kw'>self</span> + <span class='@from ivar id'>@from</span> <span class='assign token'>=</span> <span class='Marker constant id'>Marker</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> + <span class='@object ivar id'>@object</span> <span class='assign token'>=</span> <span class='Pic constant id'>Pic</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -525,8 +542,9 @@ ppi resolution.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The drawing that holds this anchor</p> + <p> +The drawing that holds this anchor +</p> </div> @@ -560,9 +578,10 @@ ppi resolution.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/one_cell_anchor.rb', line 18</span> -<span class='kw'>def</span> <span class='id drawing'>drawing</span> - <span class='ivar'>@drawing</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='drawing identifier id'>drawing</span> + <span class='@drawing ivar id'>@drawing</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -580,9 +599,10 @@ ppi resolution.</p> </p><div class="docstring"> <div class="discussion"> - -<p>A marker that defines the from cell anchor. The default from column and row -are 0 and 0 respectively</p> + <p> +A marker that defines the from cell anchor. The default from column and row +are 0 and 0 respectively +</p> </div> @@ -616,9 +636,10 @@ are 0 and 0 respectively</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/one_cell_anchor.rb', line 10</span> -<span class='kw'>def</span> <span class='id from'>from</span> - <span class='ivar'>@from</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='from identifier id'>from</span> + <span class='@from ivar id'>@from</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -636,9 +657,10 @@ are 0 and 0 respectively</p> </p><div class="docstring"> <div class="discussion"> - -<p>the height of the graphic object in pixels this is converted to EMU at a 92 -ppi resolution</p> + <p> +the height of the graphic object in pixels this is converted to EMU at a 92 +ppi resolution +</p> </div> @@ -672,9 +694,10 @@ ppi resolution</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/one_cell_anchor.rb', line 28</span> -<span class='kw'>def</span> <span class='id height'>height</span> - <span class='ivar'>@height</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='height identifier id'>height</span> + <span class='@height ivar id'>@height</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -692,8 +715,9 @@ ppi resolution</p> </p><div class="docstring"> <div class="discussion"> - -<p>The object this anchor hosts</p> + <p> +The object this anchor hosts +</p> </div> @@ -727,9 +751,10 @@ ppi resolution</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/one_cell_anchor.rb', line 14</span> -<span class='kw'>def</span> <span class='id object'>object</span> - <span class='ivar'>@object</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='object identifier id'>object</span> + <span class='@object ivar id'>@object</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -747,9 +772,10 @@ ppi resolution</p> </p><div class="docstring"> <div class="discussion"> - -<p>the width of the graphic object in pixels. this is converted to EMU at a 92 -ppi resolution</p> + <p> +the width of the graphic object in pixels. this is converted to EMU at a 92 +ppi resolution +</p> </div> @@ -783,9 +809,10 @@ ppi resolution</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/one_cell_anchor.rb', line 23</span> -<span class='kw'>def</span> <span class='id width'>width</span> - <span class='ivar'>@width</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='width identifier id'>width</span> + <span class='@width ivar id'>@width</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -807,8 +834,9 @@ ppi resolution</p> </p><div class="docstring"> <div class="discussion"> - -<p>The index of this anchor in the drawing</p> + <p> +The index of this anchor in the drawing +</p> </div> @@ -842,9 +870,10 @@ ppi resolution</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/one_cell_anchor.rb', line 59</span> -<span class='kw'>def</span> <span class='id index'>index</span> - <span class='ivar'>@drawing</span><span class='period'>.</span><span class='id anchors'>anchors</span><span class='period'>.</span><span class='id index'>index</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='index identifier id'>index</span> + <span class='@drawing ivar id'>@drawing</span><span class='dot token'>.</span><span class='anchors identifier id'>anchors</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -859,8 +888,9 @@ ppi resolution</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the anchor</p> + <p> +Serializes the anchor +</p> </div> @@ -879,8 +909,9 @@ ppi resolution</p> — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -921,16 +952,17 @@ ppi resolution</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/one_cell_anchor.rb', line 66</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>xdr:oneCellAnchor</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>xdr:from</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id from'>from</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='rbrace'>}</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>xdr:ext</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id ext'>ext</span><span class='rparen'>)</span> - <span class='ivar'>@object</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>xdr:clientData</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> - <span class='rbrace'>}</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:oneCellAnchor'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:from'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='from identifier id'>from</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:ext'</span><span class='comma token'>,</span> <span class='ext identifier id'>ext</span><span class='rparen token'>)</span> + <span class='@object ivar id'>@object</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:clientData'</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -941,9 +973,9 @@ ppi resolution</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:39 2011 by + Generated on Sun Nov 27 18:05:19 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/Override.html b/doc/Axlsx/Override.html index 542e1ad5..60f12a51 100644 --- a/doc/Axlsx/Override.html +++ b/doc/Axlsx/Override.html @@ -94,9 +94,10 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>An override content part. These parts are automatically created by for you -based on the content of your package.</p> + <p> +An override content part. These parts are automatically created by for you +based on the content of your package. +</p> </div> @@ -128,8 +129,9 @@ based on the content of your package.</p> - <span class="summary_desc"><div class='inline'> -<p>The type of content.</p> + <span class="summary_desc"><div class='inline'><p> +The type of content. +</p> </div></span> </li> @@ -154,8 +156,9 @@ based on the content of your package.</p> - <span class="summary_desc"><div class='inline'> -<p>The name and location of the part.</p> + <span class="summary_desc"><div class='inline'><p> +The name and location of the part. +</p> </div></span> </li> @@ -192,8 +195,9 @@ based on the content of your package.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a new Override object.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new Override object. +</p> </div></span> </li> @@ -215,8 +219,9 @@ based on the content of your package.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the Override object to xml.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the Override object to xml. +</p> </div></span> </li> @@ -237,8 +242,9 @@ based on the content of your package.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new Override object</p> + <p> +Creates a new Override object +</p> </div> @@ -259,8 +265,9 @@ based on the content of your package.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -305,9 +312,10 @@ based on the content of your package.</p> — - <div class='inline'> -<p>An argument error is raised if both PartName and ContentType are not -specified.</p> + <div class='inline'><p> +An argument error is raised if both PartName and ContentType are not +specified. +</p> </div> </li> @@ -330,12 +338,13 @@ specified.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line 17</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='id raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>PartName and ContentType are required</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:PartName</span><span class='rbracket'>]</span> <span class='op'>&&</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:ContentType</span><span class='rbracket'>]</span> - <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span> - <span class='kw'>end</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='string val'>"PartName and ContentType are required"</span> <span class='unless unless_mod kw'>unless</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:PartName</span><span class='rbrack token'>]</span> <span class='andop op'>&&</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:ContentType</span><span class='rbrack token'>]</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -358,8 +367,9 @@ specified.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The type of content.</p> + <p> +The type of content. +</p> </div> @@ -393,9 +403,10 @@ specified.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line 7</span> -<span class='kw'>def</span> <span class='const'>ContentType</span> - <span class='ivar'>@ContentType</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='ContentType constant id'>ContentType</span> + <span class='@ContentType ivar id'>@ContentType</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -413,8 +424,9 @@ specified.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The name and location of the part.</p> + <p> +The name and location of the part. +</p> </div> @@ -448,9 +460,10 @@ specified.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line 11</span> -<span class='kw'>def</span> <span class='const'>PartName</span> - <span class='ivar'>@PartName</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='PartName constant id'>PartName</span> + <span class='@PartName ivar id'>@PartName</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -472,8 +485,9 @@ specified.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the Override object to xml</p> + <p> +Serializes the Override object to xml +</p> </div> @@ -492,8 +506,9 @@ specified.</p> — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -514,9 +529,10 @@ specified.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line 33</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='const'>Override</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id instance_values'>instance_values</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='Override constant id'>Override</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -527,9 +543,9 @@ specified.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:39 2011 by + Generated on Sun Nov 27 18:05:15 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/Package.html b/doc/Axlsx/Package.html index 6ab5ca37..7b0a39c1 100644 --- a/doc/Axlsx/Package.html +++ b/doc/Axlsx/Package.html @@ -94,10 +94,11 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>Package is responsible for managing all the bits and peices that Open + <p> +Package is responsible for managing all the bits and peices that Open Office XML requires to make a valid xlsx document including valdation and -serialization.</p> +serialization. +</p> </div> @@ -136,8 +137,33 @@ serialization.</p> - <span class="summary_desc"><div class='inline'> -<p>Initializes your package.</p> + <span class="summary_desc"><div class='inline'><p> +Initializes your package. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#ruport_table-instance_method" title="#ruport_table (instance method)">- (Object) <strong>ruport_table</strong>(table) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Accepts a ruport table for serialization to xlsx. +</p> </div></span> </li> @@ -159,8 +185,9 @@ serialization.</p> - <span class="summary_desc"><div class='inline'> -<p>Serialize your workbook to disk as an xlsx document.</p> + <span class="summary_desc"><div class='inline'><p> +Serialize your workbook to disk as an xlsx document. +</p> </div></span> </li> @@ -182,8 +209,9 @@ serialization.</p> - <span class="summary_desc"><div class='inline'> -<p>Validate all parts of the package against xsd schema.</p> + <span class="summary_desc"><div class='inline'><p> +Validate all parts of the package against xsd schema. +</p> </div></span> </li> @@ -205,8 +233,9 @@ serialization.</p> - <span class="summary_desc"><div class='inline'> -<p>The workbook this package will serialize or validate.</p> + <span class="summary_desc"><div class='inline'><p> +The workbook this package will serialize or validate. +</p> </div></span> </li> @@ -248,8 +277,9 @@ serialization.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Initializes your package</p> + <p> +Initializes your package +</p> </div> @@ -259,10 +289,12 @@ serialization.</p> <div class="examples"> <h3>Examples:</h3> - <h4><div class='inline'> -<p>Package.new :author => ‘you!’, :workbook => Workbook.new</p> + <h4><div class='inline'><p> +Package.new :author => ‘you!’, :workbook => Workbook.new +</p> </div></h4> - <pre class="example code"></pre> + <pre class="example code"> +</pre> </div> <h3>Parameters:</h3> @@ -280,9 +312,10 @@ serialization.</p> — - <div class='inline'> -<p>A hash that you can use to specify the author and workbook for this -package.</p> + <div class='inline'><p> +A hash that you can use to specify the author and workbook for this +package. +</p> </div> </li> @@ -301,8 +334,9 @@ package.</p> <span class="default"> </span> - — <div class='inline'> -<p>The author of the document</p> + — <div class='inline'><p> +The author of the document +</p> </div> </li> @@ -335,8 +369,9 @@ package.</p> — - <div class='inline'> -<p>the object that the method was called on</p> + <div class='inline'><p> +the object that the method was called on +</p> </div> </li> @@ -359,12 +394,13 @@ package.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 12</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='ivar'>@workbook</span> <span class='op'>=</span> <span class='kw'>nil</span> - <span class='ivar'>@core</span><span class='comma'>,</span> <span class='ivar'>@app</span> <span class='op'>=</span> <span class='const'>Core</span><span class='period'>.</span><span class='id new'>new</span><span class='comma'>,</span> <span class='const'>App</span><span class='period'>.</span><span class='id new'>new</span> - <span class='ivar'>@core</span><span class='period'>.</span><span class='id creator'>creator</span> <span class='op'>=</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:author</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='ivar'>@core</span><span class='period'>.</span><span class='id creator'>creator</span> - <span class='kw'>yield</span> <span class='kw'>self</span> <span class='kw'>if</span> <span class='id block_given?'>block_given?</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@workbook ivar id'>@workbook</span> <span class='assign token'>=</span> <span class='nil nil kw'>nil</span> + <span class='@core ivar id'>@core</span><span class='comma token'>,</span> <span class='@app ivar id'>@app</span> <span class='assign token'>=</span> <span class='Core constant id'>Core</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='comma token'>,</span> <span class='App constant id'>App</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='@core ivar id'>@core</span><span class='dot token'>.</span><span class='creator identifier id'>creator</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:author</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='@core ivar id'>@core</span><span class='dot token'>.</span><span class='creator identifier id'>creator</span> + <span class='yield yield kw'>yield</span> <span class='self self kw'>self</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -378,7 +414,69 @@ package.</p> <div class="method_details first"> - <p class="signature first" id="serialize-instance_method"> + <p class="signature first" id="ruport_table-instance_method"> + + - (<tt>Object</tt>) <strong>ruport_table</strong>(table) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Accepts a ruport table for serialization to xlsx +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>table</span> + + + <span class='type'>(<tt>Table</tt>)</span> + + + + — + <div class='inline'><p> +a ruport Table object +</p> +</div> + + </li> + +</ul> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +21 +22 +23</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 21</span> + +<span class='def def kw'>def</span> <span class='ruport_table identifier id'>ruport_table</span><span class='lparen token'>(</span><span class='table identifier id'>table</span><span class='rparen token'>)</span> + <span class='puts identifier id'>puts</span> <span class='table identifier id'>table</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="serialize-instance_method"> - (<tt>Boolean</tt>) <strong>serialize</strong>(output, confirm_valid = false) @@ -389,15 +487,17 @@ package.</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>A tremendous amount of effort has gone into ensuring that you cannot create + <div class='inline'><p> +A tremendous amount of effort has gone into ensuring that you cannot create invalid xlsx documents. confirm_valid should be used in the rare case that -you cannot open the serialized file.</p> +you cannot open the serialized file. +</p> </div> </div> - -<p>Serialize your workbook to disk as an xlsx document.</p> +<p> +Serialize your workbook to disk as an xlsx document. +</p> </div> @@ -408,12 +508,13 @@ you cannot open the serialized file.</p> <h3>Examples:</h3> <h4><div class='inline'></div></h4> - <pre class="example code"><span class='comment'># This is how easy it is to create a valid xlsx file. Of course you might want to add a sheet or two, and maybe some data, styles and charts. -</span><span class='comment'># Take a look at the README for an example of how to do it! -</span><span class='id f'>f</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id open'>open</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>test.xlsx</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>w</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> -<span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span><span class='period'>.</span><span class='id serialize'>serialize</span><span class='lparen'>(</span><span class='id f'>f</span><span class='rparen'>)</span> + <pre class="example code"><span class='comment val'># This is how easy it is to create a valid xlsx file. Of course you might want to add a sheet or two, and maybe some data, styles and charts.</span> +<span class='comment val'># Take a look at the README for an example of how to do it!</span> +<span class='f identifier id'>f</span> <span class='assign token'>=</span> <span class='File constant id'>File</span><span class='dot token'>.</span><span class='open identifier id'>open</span><span class='lparen token'>(</span><span class='string val'>'test.xlsx'</span><span class='comma token'>,</span> <span class='string val'>'w'</span><span class='rparen token'>)</span> +<span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='f identifier id'>f</span><span class='rparen token'>)</span> -<span class='comment'># You will find a file called test.xlsx</span></pre> +<span class='comment val'># You will find a file called test.xlsx</span> +</pre> </div> <h3>Parameters:</h3> @@ -429,8 +530,9 @@ you cannot open the serialized file.</p> — - <div class='inline'> -<p>The file you want to serialize your package to</p> + <div class='inline'><p> +The file you want to serialize your package to +</p> </div> </li> @@ -447,8 +549,9 @@ you cannot open the serialized file.</p> — - <div class='inline'> -<p>Validate the package prior to serialization.</p> + <div class='inline'><p> +Validate the package prior to serialization. +</p> </div> </li> @@ -466,9 +569,10 @@ you cannot open the serialized file.</p> — - <div class='inline'> -<p>False if confirm_valid and validation errors exist. True if the package was -serialized</p> + <div class='inline'><p> +False if confirm_valid and validation errors exist. True if the package was +serialized +</p> </div> </li> @@ -488,11 +592,6 @@ serialized</p> <pre class="lines"> -54 -55 -56 -57 -58 59 60 61 @@ -505,29 +604,35 @@ serialized</p> 68 69 70 -71</pre> +71 +72 +73 +74 +75 +76</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 54</span> - -<span class='kw'>def</span> <span class='id serialize'>serialize</span><span class='lparen'>(</span><span class='id output'>output</span><span class='comma'>,</span> <span class='id confirm_valid'>confirm_valid</span><span class='op'>=</span><span class='kw'>false</span><span class='rparen'>)</span> - <span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>unless</span> <span class='op'>!</span><span class='id confirm_valid'>confirm_valid</span> <span class='op'>||</span> <span class='kw'>self</span><span class='period'>.</span><span class='id validate'>validate</span><span class='period'>.</span><span class='id empty?'>empty?</span> - <span class='id p'>p</span> <span class='op'>=</span> <span class='id parts'>parts</span> - <span class='const'>Zip</span><span class='op'>::</span><span class='const'>ZipOutputStream</span><span class='period'>.</span><span class='id open'>open</span><span class='lparen'>(</span><span class='id output'>output</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id zip'>zip</span><span class='op'>|</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id part'>part</span><span class='op'>|</span> - <span class='kw'>unless</span> <span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:doc</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='id zip'>zip</span><span class='period'>.</span><span class='id put_next_entry'>put_next_entry</span><span class='lparen'>(</span><span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:entry</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='semicolon'>;</span> - <span class='id zip'>zip</span><span class='period'>.</span><span class='id puts'>puts</span><span class='lparen'>(</span><span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:doc</span><span class='rbracket'>]</span><span class='rparen'>)</span> - <span class='kw'>end</span> - <span class='kw'>unless</span> <span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:path</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='id zip'>zip</span><span class='period'>.</span><span class='id put_next_entry'>put_next_entry</span><span class='lparen'>(</span><span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:entry</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='semicolon'>;</span> - <span class='comment'># binread for 1.9.3 -</span> <span class='id zip'>zip</span><span class='period'>.</span><span class='id write'>write</span> <span class='const'>IO</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:binread</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='const'>IO</span><span class='period'>.</span><span class='id binread'>binread</span><span class='lparen'>(</span><span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:path</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='const'>IO</span><span class='period'>.</span><span class='id read'>read</span><span class='lparen'>(</span><span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:path</span><span class='rbracket'>]</span><span class='rparen'>)</span> - <span class='kw'>end</span> - <span class='kw'>end</span> - <span class='kw'>end</span> - <span class='kw'>true</span> -<span class='kw'>end</span></pre> + <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 59</span> + +<span class='def def kw'>def</span> <span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='output identifier id'>output</span><span class='comma token'>,</span> <span class='confirm_valid identifier id'>confirm_valid</span><span class='assign token'>=</span><span class='false false kw'>false</span><span class='rparen token'>)</span> + <span class='return return kw'>return</span> <span class='false false kw'>false</span> <span class='unless unless_mod kw'>unless</span> <span class='notop op'>!</span><span class='confirm_valid identifier id'>confirm_valid</span> <span class='orop op'>||</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='dot token'>.</span><span class='empty? fid id'>empty?</span> + <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='parts identifier id'>parts</span> + <span class='Zip constant id'>Zip</span><span class='colon2 op'>::</span><span class='ZipOutputStream constant id'>ZipOutputStream</span><span class='dot token'>.</span><span class='open identifier id'>open</span><span class='lparen token'>(</span><span class='output identifier id'>output</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='zip identifier id'>zip</span><span class='bitor op'>|</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='part identifier id'>part</span><span class='bitor op'>|</span> + <span class='unless unless kw'>unless</span> <span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:doc</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='zip identifier id'>zip</span><span class='dot token'>.</span><span class='put_next_entry identifier id'>put_next_entry</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:entry</span><span class='rbrack token'>]</span><span class='rparen token'>)</span><span class='semicolon token'>;</span> + <span class='zip identifier id'>zip</span><span class='dot token'>.</span><span class='puts identifier id'>puts</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:doc</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> + <span class='unless unless kw'>unless</span> <span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:path</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='zip identifier id'>zip</span><span class='dot token'>.</span><span class='put_next_entry identifier id'>put_next_entry</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:entry</span><span class='rbrack token'>]</span><span class='rparen token'>)</span><span class='semicolon token'>;</span> + <span class='comment val'># binread for 1.9.3</span> + <span class='zip identifier id'>zip</span><span class='dot token'>.</span><span class='write identifier id'>write</span> <span class='IO constant id'>IO</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span><span class='lparen token'>(</span><span class='symbol val'>:binread</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='IO constant id'>IO</span><span class='dot token'>.</span><span class='binread identifier id'>binread</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:path</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='colon op'>:</span> <span class='IO constant id'>IO</span><span class='dot token'>.</span><span class='read identifier id'>read</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:path</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> + <span class='end end kw'>end</span> + <span class='end end kw'>end</span> + <span class='true true kw'>true</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -545,22 +650,25 @@ serialized</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>This gem includes all schema from OfficeOpenXML-XMLSchema-Transitional.zip + <div class='inline'><p> +This gem includes all schema from OfficeOpenXML-XMLSchema-Transitional.zip and OpenPackagingConventions-XMLSchema.zip as per ECMA-376, Third edition. opc schema require an internet connection to import remote schema from dublin core for dc, dcterms and xml namespaces. Those remote schema are -included in this gem, and the original files have been altered to refer to -the local versions.</p> - -<p>If by chance you are able to creat a package that does not validate it +included in this gem, and the original files have been altered to refer to +the local versions. +</p> +<p> +If by chance you are able to creat a package that does not validate it indicates that the internal validation is not robust enough and needs to be -improved. Please report your errors to the gem author.</p> +improved. Please report your errors to the gem author. +</p> </div> </div> - -<p>Validate all parts of the package against xsd schema.</p> +<p> +Validate all parts of the package against xsd schema. +</p> </div> @@ -571,10 +679,11 @@ improved. Please report your errors to the gem author.</p> <h3>Examples:</h3> <h4><div class='inline'></div></h4> - <pre class="example code"><span class='comment'># The following will output any error messages found in serialization. -</span><span class='id p'>p</span> <span class='op'>=</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span> -<span class='comment'># ... code to create sheets, charts, styles etc. -</span><span class='id p'>p</span><span class='period'>.</span><span class='id validate'>validate</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id error'>error</span><span class='op'>|</span> <span class='id puts'>puts</span> <span class='id error'>error</span><span class='period'>.</span><span class='id message'>message</span> <span class='rbrace'>}</span></pre> + <pre class="example code"><span class='comment val'># The following will output any error messages found in serialization.</span> +<span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> +<span class='comment val'># ... code to create sheets, charts, styles etc.</span> +<span class='p identifier id'>p</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='error identifier id'>error</span><span class='bitor op'>|</span> <span class='puts identifier id'>puts</span> <span class='error identifier id'>error</span><span class='dot token'>.</span><span class='message identifier id'>message</span> <span class='rbrace token'>}</span> +</pre> </div> @@ -589,8 +698,9 @@ improved. Please report your errors to the gem author.</p> — - <div class='inline'> -<p>An array of all validation errors found.</p> + <div class='inline'><p> +An array of all validation errors found. +</p> </div> </li> @@ -610,20 +720,21 @@ improved. Please report your errors to the gem author.</p> <pre class="lines"> -88 -89 -90 -91 -92</pre> +93 +94 +95 +96 +97</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 88</span> - -<span class='kw'>def</span> <span class='id validate'>validate</span> - <span class='id errors'>errors</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span> - <span class='id parts'>parts</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id part'>part</span><span class='op'>|</span> <span class='id errors'>errors</span><span class='period'>.</span><span class='id concat'>concat</span> <span class='id validate_single_doc'>validate_single_doc</span><span class='lparen'>(</span><span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:schema</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:doc</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id part'>part</span><span class='lbracket'>[</span><span class='symbol'>:schema</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span> <span class='rbrace'>}</span> - <span class='id errors'>errors</span> -<span class='kw'>end</span></pre> + <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 93</span> + +<span class='def def kw'>def</span> <span class='validate identifier id'>validate</span> + <span class='errors identifier id'>errors</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span> + <span class='parts identifier id'>parts</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='part identifier id'>part</span><span class='bitor op'>|</span> <span class='errors identifier id'>errors</span><span class='dot token'>.</span><span class='concat identifier id'>concat</span> <span class='validate_single_doc identifier id'>validate_single_doc</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:schema</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:doc</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:schema</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> <span class='rbrace token'>}</span> + <span class='errors identifier id'>errors</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -641,22 +752,25 @@ improved. Please report your errors to the gem author.</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>As there are multiple ways to instantiate a workbook for the package, here -are a few examples:</p> - -<pre class="code"><span class='comment'># assign directly during package instanciation -</span><span class='id wb'>wb</span> <span class='op'>=</span> <span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='symbol'>:workbook</span> <span class='op'>=></span> <span class='const'>Workbook</span><span class='period'>.</span><span class='id new'>new</span><span class='rparen'>)</span><span class='period'>.</span><span class='id workbook'>workbook</span> - -<span class='comment'># get a fresh workbook automatically from the package -</span><span class='id wb'>wb</span> <span class='op'>=</span> <span class='const'>Pacakge</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='rparen'>)</span><span class='period'>.</span><span class='id workbook'>workbook</span> -<span class='comment'># # set the workbook after creating the package -</span><span class='id wb'>wb</span> <span class='op'>=</span> <span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='rparen'>)</span><span class='period'>.</span><span class='id workbook'>workbook</span> <span class='op'>=</span> <span class='const'>Workbook</span><span class='period'>.</span><span class='id new'>new</span></pre> + <div class='inline'><p> +As there are multiple ways to instantiate a workbook for the package, here +are a few examples: +</p> +<pre class="code"> + <span class='comment val'># assign directly during package instanciation</span> + <span class='wb identifier id'>wb</span> <span class='assign token'>=</span> <span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:workbook</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Workbook constant id'>Workbook</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span> + + <span class='comment val'># get a fresh workbook automatically from the package</span> + <span class='wb identifier id'>wb</span> <span class='assign token'>=</span> <span class='Pacakge constant id'>Pacakge</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span> + <span class='comment val'># # set the workbook after creating the package</span> + <span class='wb identifier id'>wb</span> <span class='assign token'>=</span> <span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span> <span class='assign token'>=</span> <span class='Workbook constant id'>Workbook</span><span class='dot token'>.</span><span class='new identifier id'>new</span> +</pre> </div> </div> - -<p>The workbook this package will serialize or validate.</p> +<p> +The workbook this package will serialize or validate. +</p> </div> @@ -674,9 +788,10 @@ are a few examples:</p> — - <div class='inline'> -<p>If no workbook instance has been assigned with this package a new Workbook -instance is returned.</p> + <div class='inline'><p> +If no workbook instance has been assigned with this package a new Workbook +instance is returned. +</p> </div> </li> @@ -693,8 +808,9 @@ instance is returned.</p> - <div class='inline'> -<p>ArgumentError if workbook parameter is not a Workbook instance.</p> + <div class='inline'><p> +ArgumentError if workbook parameter is not a Workbook instance. +</p> </div> </li> @@ -707,16 +823,17 @@ instance is returned.</p> <pre class="lines"> -32 -33 -34</pre> +37 +38 +39</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 32</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 37</span> -<span class='kw'>def</span> <span class='id workbook'>workbook</span> - <span class='ivar'>@workbook</span> <span class='op'>||</span> <span class='ivar'>@workbook</span> <span class='op'>=</span> <span class='const'>Workbook</span><span class='period'>.</span><span class='id new'>new</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='workbook identifier id'>workbook</span> + <span class='@workbook ivar id'>@workbook</span> <span class='orop op'>||</span> <span class='@workbook ivar id'>@workbook</span> <span class='assign token'>=</span> <span class='Workbook constant id'>Workbook</span><span class='dot token'>.</span><span class='new identifier id'>new</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -751,12 +868,13 @@ instance is returned.</p> <pre class="lines"> -37</pre> +42</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 37</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 42</span> -<span class='kw'>def</span> <span class='id workbook='>workbook=</span><span class='lparen'>(</span><span class='id workbook'>workbook</span><span class='rparen'>)</span> <span class='const'>DataTypeValidator</span><span class='period'>.</span><span class='id validate'>validate</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Package.workbook</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='const'>Workbook</span><span class='comma'>,</span> <span class='id workbook'>workbook</span><span class='semicolon'>;</span> <span class='ivar'>@workbook</span> <span class='op'>=</span> <span class='id workbook'>workbook</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='workbook= identifier id'>workbook=</span><span class='lparen token'>(</span><span class='workbook identifier id'>workbook</span><span class='rparen token'>)</span> <span class='DataTypeValidator constant id'>DataTypeValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='string val'>"Package.workbook"</span><span class='comma token'>,</span> <span class='Workbook constant id'>Workbook</span><span class='comma token'>,</span> <span class='workbook identifier id'>workbook</span><span class='semicolon token'>;</span> <span class='@workbook ivar id'>@workbook</span> <span class='assign token'>=</span> <span class='workbook identifier id'>workbook</span> <span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -767,9 +885,9 @@ instance is returned.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:36 2011 by + Generated on Sun Nov 27 18:05:16 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/PatternFill.html b/doc/Axlsx/PatternFill.html index c49ced12..c3916fe2 100644 --- a/doc/Axlsx/PatternFill.html +++ b/doc/Axlsx/PatternFill.html @@ -97,13 +97,15 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage styles is with Styles#add_style</p> + <div class='inline'><p> +The recommended way to manage styles is with Styles#add_style +</p> </div> </div> - -<p>A PatternFill is the pattern and solid fill styling for a cell.</p> +<p> +A PatternFill is the pattern and solid fill styling for a cell. +</p> </div> @@ -142,8 +144,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The color to use for the background of the fill when the type is not solid.</p> + <span class="summary_desc"><div class='inline'><p> +The color to use for the background of the fill when the type is not solid. +</p> </div></span> </li> @@ -168,8 +171,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The color to use for the the background in solid fills.</p> + <span class="summary_desc"><div class='inline'><p> +The color to use for the the background in solid fills. +</p> </div></span> </li> @@ -194,8 +198,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The pattern type to use.</p> + <span class="summary_desc"><div class='inline'><p> +The pattern type to use. +</p> </div></span> </li> @@ -232,8 +237,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Creates a new PatternFill Object.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new PatternFill Object. +</p> </div></span> </li> @@ -255,8 +261,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Serializes the pattern fill.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the pattern fill. +</p> </div></span> </li> @@ -277,8 +284,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new PatternFill Object</p> + <p> +Creates a new PatternFill Object +</p> </div> @@ -299,8 +307,9 @@ — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -360,12 +369,13 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/pattern_fill.rb', line 44</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='ivar'>@patternType</span> <span class='op'>=</span> <span class='symbol'>:none</span> - <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span> - <span class='kw'>end</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@patternType ivar id'>@patternType</span> <span class='assign token'>=</span> <span class='symbol val'>:none</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -388,8 +398,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>The color to use for the background of the fill when the type is not solid.</p> + <p> +The color to use for the background of the fill when the type is not solid. +</p> </div> @@ -423,9 +434,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/pattern_fill.rb', line 13</span> -<span class='kw'>def</span> <span class='id bgColor'>bgColor</span> - <span class='ivar'>@bgColor</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='bgColor identifier id'>bgColor</span> + <span class='@bgColor ivar id'>@bgColor</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -443,8 +455,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>The color to use for the the background in solid fills.</p> + <p> +The color to use for the the background in solid fills. +</p> </div> @@ -478,9 +491,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/pattern_fill.rb', line 9</span> -<span class='kw'>def</span> <span class='id fgColor'>fgColor</span> - <span class='ivar'>@fgColor</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='fgColor identifier id'>fgColor</span> + <span class='@fgColor ivar id'>@fgColor</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -501,33 +515,36 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>patternType must be one of</p> - -<pre class="code"><span class='symbol'>:none</span> -<span class='symbol'>:solid</span> -<span class='symbol'>:mediumGray</span> -<span class='symbol'>:darkGray</span> -<span class='symbol'>:lightGray</span> -<span class='symbol'>:darkHorizontal</span> -<span class='symbol'>:darkVertical</span> -<span class='symbol'>:darkDown</span> -<span class='symbol'>:darkUp</span> -<span class='symbol'>:darkGrid</span> -<span class='symbol'>:darkTrellis</span> -<span class='symbol'>:lightHorizontal</span> -<span class='symbol'>:lightVertical</span> -<span class='symbol'>:lightDown</span> -<span class='symbol'>:lightUp</span> -<span class='symbol'>:lightGrid</span> -<span class='symbol'>:lightTrellis</span> -<span class='symbol'>:gray125</span> -<span class='symbol'>:gray0625</span></pre> + <div class='inline'><p> +patternType must be one of +</p> +<pre class="code"> + <span class='symbol val'>:none</span> + <span class='symbol val'>:solid</span> + <span class='symbol val'>:mediumGray</span> + <span class='symbol val'>:darkGray</span> + <span class='symbol val'>:lightGray</span> + <span class='symbol val'>:darkHorizontal</span> + <span class='symbol val'>:darkVertical</span> + <span class='symbol val'>:darkDown</span> + <span class='symbol val'>:darkUp</span> + <span class='symbol val'>:darkGrid</span> + <span class='symbol val'>:darkTrellis</span> + <span class='symbol val'>:lightHorizontal</span> + <span class='symbol val'>:lightVertical</span> + <span class='symbol val'>:lightDown</span> + <span class='symbol val'>:lightUp</span> + <span class='symbol val'>:lightGrid</span> + <span class='symbol val'>:lightTrellis</span> + <span class='symbol val'>:gray125</span> + <span class='symbol val'>:gray0625</span> +</pre> </div> </div> - -<p>The pattern type to use</p> +<p> +The pattern type to use +</p> </div> @@ -555,9 +572,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/pattern_fill.rb', line 38</span> -<span class='kw'>def</span> <span class='id patternType'>patternType</span> - <span class='ivar'>@patternType</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='patternType identifier id'>patternType</span> + <span class='@patternType ivar id'>@patternType</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -579,8 +597,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the pattern fill</p> + <p> +Serializes the pattern fill +</p> </div> @@ -599,8 +618,9 @@ — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -636,11 +656,12 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/pattern_fill.rb', line 60</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id patternFill'>patternFill</span><span class='lparen'>(</span><span class='symbol'>:patternType</span> <span class='op'>=></span> <span class='kw'>self</span><span class='period'>.</span><span class='id patternType'>patternType</span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id instance_values'>instance_values</span><span class='period'>.</span><span class='id reject'>reject</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id k'>k</span><span class='comma'>,</span><span class='id v'>v</span><span class='op'>|</span> <span class='id k'>k</span><span class='period'>.</span><span class='id to_sym'>to_sym</span> <span class='op'>==</span> <span class='symbol'>:patternType</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id k'>k</span><span class='comma'>,</span><span class='id v'>v</span><span class='op'>|</span> <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='id k'>k</span><span class='comma'>,</span> <span class='id v'>v</span><span class='period'>.</span><span class='id instance_values'>instance_values</span><span class='rparen'>)</span> <span class='rbrace'>}</span> - <span class='rbrace'>}</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='patternFill identifier id'>patternFill</span><span class='lparen token'>(</span><span class='symbol val'>:patternType</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='patternType identifier id'>patternType</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='dot token'>.</span><span class='reject identifier id'>reject</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='k identifier id'>k</span><span class='comma token'>,</span><span class='v identifier id'>v</span><span class='bitor op'>|</span> <span class='k identifier id'>k</span><span class='dot token'>.</span><span class='to_sym identifier id'>to_sym</span> <span class='eq op'>==</span> <span class='symbol val'>:patternType</span> <span class='rbrace token'>}</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='k identifier id'>k</span><span class='comma token'>,</span><span class='v identifier id'>v</span><span class='bitor op'>|</span> <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='k identifier id'>k</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -651,9 +672,9 @@ </div> <div id="footer"> - Generated on Sat Nov 26 13:16:39 2011 by + Generated on Sun Nov 27 18:05:02 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/Pic.html b/doc/Axlsx/Pic.html index c18b3682..27dd83cf 100644 --- a/doc/Axlsx/Pic.html +++ b/doc/Axlsx/Pic.html @@ -94,9 +94,10 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>a Pic object represents an image in your worksheet Worksheet#add_image is -the recommended way to manage images in your sheets</p> + <p> +a Pic object represents an image in your worksheet Worksheet#add_image is +the recommended way to manage images in your sheets +</p> </div> @@ -119,8 +120,9 @@ the recommended way to manage images in your sheets</p> <dt id="ALLOWED_EXTENSIONS-constant" class="">ALLOWED_EXTENSIONS = <div class="docstring"> <div class="discussion"> - -<p>allowed file extenstions</p> + <p> +allowed file extenstions +</p> </div> @@ -130,7 +132,8 @@ the recommended way to manage images in your sheets</p> </div> </dt> - <dd><pre class="code"><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>gif</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>jpeg</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>png</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>jpg</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span></pre></dd> + <dd><pre class="code"><span class='lbrack token'>[</span><span class='string val'>'gif'</span><span class='comma token'>,</span> <span class='string val'>'jpeg'</span><span class='comma token'>,</span> <span class='string val'>'png'</span><span class='comma token'>,</span> <span class='string val'>'jpg'</span><span class='rbrack token'>]</span> +</pre></dd> </dl> @@ -158,8 +161,9 @@ the recommended way to manage images in your sheets</p> - <span class="summary_desc"><div class='inline'> -<p>The anchor for this image.</p> + <span class="summary_desc"><div class='inline'><p> +The anchor for this image. +</p> </div></span> </li> @@ -184,8 +188,9 @@ the recommended way to manage images in your sheets</p> - <span class="summary_desc"><div class='inline'> -<p>A description of the picture.</p> + <span class="summary_desc"><div class='inline'><p> +A description of the picture. +</p> </div></span> </li> @@ -210,9 +215,10 @@ the recommended way to manage images in your sheets</p> - <span class="summary_desc"><div class='inline'> -<p>The path to the image you want to include Only local images are supported -at this time and only jpg support.</p> + <span class="summary_desc"><div class='inline'><p> +The path to the image you want to include Only local images are supported +at this time and only jpg support. +</p> </div></span> </li> @@ -237,8 +243,9 @@ at this time and only jpg support.</p> - <span class="summary_desc"><div class='inline'> -<p>The name to use for this picture.</p> + <span class="summary_desc"><div class='inline'><p> +The name to use for this picture. +</p> </div></span> </li> @@ -273,8 +280,9 @@ at this time and only jpg support.</p> - <span class="summary_desc"><div class='inline'> -<p>returns the extension of image_src without the preceeding '.'.</p> + <span class="summary_desc"><div class='inline'><p> +returns the extension of image_src without the preceeding ’.’. +</p> </div></span> </li> @@ -296,8 +304,9 @@ at this time and only jpg support.</p> - <span class="summary_desc"><div class='inline'> -<p>The file name of image_src without any path information.</p> + <span class="summary_desc"><div class='inline'><p> +The file name of image_src without any path information. +</p> </div></span> </li> @@ -319,8 +328,9 @@ at this time and only jpg support.</p> - <span class="summary_desc"><div class='inline'> -<p>providing access to update the anchor's height attribute.</p> + <span class="summary_desc"><div class='inline'><p> +providing access to update the anchor’s height attribute. +</p> </div></span> </li> @@ -363,8 +373,9 @@ at this time and only jpg support.</p> - <span class="summary_desc"><div class='inline'> -<p>The index of this image in the workbooks images collections.</p> + <span class="summary_desc"><div class='inline'><p> +The index of this image in the workbooks images collections. +</p> </div></span> </li> @@ -388,8 +399,9 @@ at this time and only jpg support.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a new Pic(ture) object.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new Pic(ture) object. +</p> </div></span> </li> @@ -411,9 +423,10 @@ at this time and only jpg support.</p> - <span class="summary_desc"><div class='inline'> -<p>The part name for this image used in serialization and relationship -building.</p> + <span class="summary_desc"><div class='inline'><p> +The part name for this image used in serialization and relationship +building. +</p> </div></span> </li> @@ -435,10 +448,11 @@ building.</p> - <span class="summary_desc"><div class='inline'> -<p>This is a short cut method to set the start anchor position If you need + <span class="summary_desc"><div class='inline'><p> +This is a short cut method to set the start anchor position If you need finer granularity in positioning use graphic_frame.anchor.from.colOff / -rowOff.</p> +rowOff. +</p> </div></span> </li> @@ -460,8 +474,9 @@ rowOff.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the picture.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the picture. +</p> </div></span> </li> @@ -483,8 +498,9 @@ rowOff.</p> - <span class="summary_desc"><div class='inline'> -<p>providing access to the anchor's width attribute.</p> + <span class="summary_desc"><div class='inline'><p> +providing access to the anchor’s width attribute. +</p> </div></span> </li> @@ -526,8 +542,9 @@ rowOff.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new Pic(ture) object</p> + <p> +Creates a new Pic(ture) object +</p> </div> @@ -546,8 +563,9 @@ rowOff.</p> — - <div class='inline'> -<p>the anchor that holds this image</p> + <div class='inline'><p> +the anchor that holds this image +</p> </div> </li> @@ -564,8 +582,9 @@ rowOff.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -663,8 +682,9 @@ rowOff.</p> — - <div class='inline'> -<p>the object that the method was called on</p> + <div class='inline'><p> +the object that the method was called on +</p> </div> </li> @@ -690,15 +710,16 @@ rowOff.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 38</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id anchor'>anchor</span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='ivar'>@anchor</span> <span class='op'>=</span> <span class='id anchor'>anchor</span> - <span class='ivar'>@anchor</span><span class='period'>.</span><span class='id drawing'>drawing</span><span class='period'>.</span><span class='id worksheet'>worksheet</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id images'>images</span> <span class='op'><<</span> <span class='kw'>self</span> - <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span> - <span class='kw'>end</span> - <span class='id start_at'>start_at</span><span class='lparen'>(</span><span class='op'>*</span><span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:start_at</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:start_at</span><span class='rbracket'>]</span> - <span class='kw'>yield</span> <span class='kw'>self</span> <span class='kw'>if</span> <span class='id block_given?'>block_given?</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='anchor identifier id'>anchor</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@anchor ivar id'>@anchor</span> <span class='assign token'>=</span> <span class='anchor identifier id'>anchor</span> + <span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='worksheet identifier id'>worksheet</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='images identifier id'>images</span> <span class='lshft op'><<</span> <span class='self self kw'>self</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> + <span class='start_at identifier id'>start_at</span><span class='lparen token'>(</span><span class='mult op'>*</span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:start_at</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:start_at</span><span class='rbrack token'>]</span> + <span class='yield yield kw'>yield</span> <span class='self self kw'>self</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -721,8 +742,9 @@ rowOff.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The anchor for this image</p> + <p> +The anchor for this image +</p> </div> @@ -756,9 +778,10 @@ rowOff.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 27</span> -<span class='kw'>def</span> <span class='id anchor'>anchor</span> - <span class='ivar'>@anchor</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='anchor identifier id'>anchor</span> + <span class='@anchor ivar id'>@anchor</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -776,8 +799,9 @@ rowOff.</p> </p><div class="docstring"> <div class="discussion"> - -<p>A description of the picture</p> + <p> +A description of the picture +</p> </div> @@ -811,9 +835,10 @@ rowOff.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 18</span> -<span class='kw'>def</span> <span class='id descr'>descr</span> - <span class='ivar'>@descr</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='descr identifier id'>descr</span> + <span class='@descr ivar id'>@descr</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -831,9 +856,10 @@ rowOff.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The path to the image you want to include Only local images are supported -at this time and only jpg support</p> + <p> +The path to the image you want to include Only local images are supported +at this time and only jpg support +</p> </div> @@ -867,9 +893,10 @@ at this time and only jpg support</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 23</span> -<span class='kw'>def</span> <span class='id image_src'>image_src</span> - <span class='ivar'>@image_src</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='image_src identifier id'>image_src</span> + <span class='@image_src ivar id'>@image_src</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -887,8 +914,9 @@ at this time and only jpg support</p> </p><div class="docstring"> <div class="discussion"> - -<p>The name to use for this picture</p> + <p> +The name to use for this picture +</p> </div> @@ -922,9 +950,10 @@ at this time and only jpg support</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 13</span> -<span class='kw'>def</span> <span class='id name'>name</span> - <span class='ivar'>@name</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='name identifier id'>name</span> + <span class='@name ivar id'>@name</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -946,8 +975,9 @@ at this time and only jpg support</p> </p><div class="docstring"> <div class="discussion"> - -<p>returns the extension of image_src without the preceeding '.'</p> + <p> +returns the extension of image_src without the preceeding ’.’ +</p> </div> @@ -981,9 +1011,10 @@ at this time and only jpg support</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 70</span> -<span class='kw'>def</span> <span class='id extname'>extname</span> - <span class='const'>File</span><span class='period'>.</span><span class='id extname'>extname</span><span class='lparen'>(</span><span class='id image_src'>image_src</span><span class='rparen'>)</span><span class='period'>.</span><span class='id delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>.</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id image_src'>image_src</span><span class='period'>.</span><span class='id nil?'>nil?</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='extname identifier id'>extname</span> + <span class='File constant id'>File</span><span class='dot token'>.</span><span class='extname identifier id'>extname</span><span class='lparen token'>(</span><span class='image_src identifier id'>image_src</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='delete identifier id'>delete</span><span class='lparen token'>(</span><span class='string val'>'.'</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='image_src identifier id'>image_src</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -998,8 +1029,9 @@ at this time and only jpg support</p> </p><div class="docstring"> <div class="discussion"> - -<p>The file name of image_src without any path information</p> + <p> +The file name of image_src without any path information +</p> </div> @@ -1033,9 +1065,10 @@ at this time and only jpg support</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 64</span> -<span class='kw'>def</span> <span class='id file_name'>file_name</span> - <span class='const'>File</span><span class='period'>.</span><span class='id basename'>basename</span><span class='lparen'>(</span><span class='id image_src'>image_src</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id image_src'>image_src</span><span class='period'>.</span><span class='id nil?'>nil?</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='file_name identifier id'>file_name</span> + <span class='File constant id'>File</span><span class='dot token'>.</span><span class='basename identifier id'>basename</span><span class='lparen token'>(</span><span class='image_src identifier id'>image_src</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='image_src identifier id'>image_src</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1050,8 +1083,9 @@ at this time and only jpg support</p> </p><div class="docstring"> <div class="discussion"> - -<p>providing access to update the anchor's height attribute</p> + <p> +providing access to update the anchor’s height attribute +</p> </div> @@ -1094,9 +1128,10 @@ at this time and only jpg support</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 101</span> -<span class='kw'>def</span> <span class='id height'>height</span> - <span class='ivar'>@anchor</span><span class='period'>.</span><span class='id height'>height</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='height identifier id'>height</span> + <span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='height identifier id'>height</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1138,9 +1173,10 @@ at this time and only jpg support</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 106</span> -<span class='kw'>def</span> <span class='id height='>height=</span><span class='lparen'>(</span><span class='id v'>v</span><span class='rparen'>)</span> - <span class='ivar'>@anchor</span><span class='period'>.</span><span class='id height'>height</span> <span class='op'>=</span> <span class='id v'>v</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='height= identifier id'>height=</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='height identifier id'>height</span> <span class='assign token'>=</span> <span class='v identifier id'>v</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1155,8 +1191,9 @@ at this time and only jpg support</p> </p><div class="docstring"> <div class="discussion"> - -<p>The index of this image in the workbooks images collections</p> + <p> +The index of this image in the workbooks images collections +</p> </div> @@ -1190,9 +1227,10 @@ at this time and only jpg support</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 76</span> -<span class='kw'>def</span> <span class='id index'>index</span> - <span class='ivar'>@anchor</span><span class='period'>.</span><span class='id drawing'>drawing</span><span class='period'>.</span><span class='id worksheet'>worksheet</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id images'>images</span><span class='period'>.</span><span class='id index'>index</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='index identifier id'>index</span> + <span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='worksheet identifier id'>worksheet</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='images identifier id'>images</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1207,9 +1245,10 @@ at this time and only jpg support</p> </p><div class="docstring"> <div class="discussion"> - -<p>The part name for this image used in serialization and relationship -building</p> + <p> +The part name for this image used in serialization and relationship +building +</p> </div> @@ -1243,9 +1282,10 @@ building</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 82</span> -<span class='kw'>def</span> <span class='id pn'>pn</span> - <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'>IMAGE_PN</span> <span class='op'>%</span> <span class='lbracket'>[</span><span class='lparen'>(</span><span class='id index'>index</span><span class='op'>+</span><span class='int'>1</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id extname'>extname</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='pn identifier id'>pn</span> + <span class='dstring node'>"#{IMAGE_PN % [(index+1), extname]}"</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1260,10 +1300,11 @@ building</p> </p><div class="docstring"> <div class="discussion"> - -<p>This is a short cut method to set the start anchor position If you need + <p> +This is a short cut method to set the start anchor position If you need finer granularity in positioning use graphic_frame.anchor.from.colOff / -rowOff</p> +rowOff +</p> </div> @@ -1282,8 +1323,9 @@ rowOff</p> — - <div class='inline'> -<p>The column</p> + <div class='inline'><p> +The column +</p> </div> </li> @@ -1298,8 +1340,9 @@ rowOff</p> — - <div class='inline'> -<p>The row</p> + <div class='inline'><p> +The row +</p> </div> </li> @@ -1334,10 +1377,11 @@ rowOff</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 116</span> -<span class='kw'>def</span> <span class='id start_at'>start_at</span><span class='lparen'>(</span><span class='id x'>x</span><span class='comma'>,</span> <span class='id y'>y</span><span class='rparen'>)</span> - <span class='ivar'>@anchor</span><span class='period'>.</span><span class='id from'>from</span><span class='period'>.</span><span class='id col'>col</span> <span class='op'>=</span> <span class='id x'>x</span> - <span class='ivar'>@anchor</span><span class='period'>.</span><span class='id from'>from</span><span class='period'>.</span><span class='id row'>row</span> <span class='op'>=</span> <span class='id y'>y</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='start_at identifier id'>start_at</span><span class='lparen token'>(</span><span class='x identifier id'>x</span><span class='comma token'>,</span> <span class='y identifier id'>y</span><span class='rparen token'>)</span> + <span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='from identifier id'>from</span><span class='dot token'>.</span><span class='col identifier id'>col</span> <span class='assign token'>=</span> <span class='x identifier id'>x</span> + <span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='from identifier id'>from</span><span class='dot token'>.</span><span class='row identifier id'>row</span> <span class='assign token'>=</span> <span class='y identifier id'>y</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1352,8 +1396,9 @@ rowOff</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the picture</p> + <p> +Serializes the picture +</p> </div> @@ -1372,8 +1417,9 @@ rowOff</p> — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -1429,31 +1475,32 @@ rowOff</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 124</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>xdr:pic</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>xdr:nvPicPr</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>xdr:cNvPr</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:id</span><span class='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>2</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='symbol'>:name</span><span class='op'>=></span><span class='id name'>name</span><span class='comma'>,</span> <span class='symbol'>:descr</span><span class='op'>=></span><span class='id descr'>descr</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>xdr:cNvPicPr</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>a:picLocks</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:noChangeAspect</span><span class='op'>=></span><span class='int'>1</span><span class='rparen'>)</span> - <span class='rbrace'>}</span> - <span class='rbrace'>}</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>xdr:blipFill</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>a:blip</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:xmlns:r</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='const'>XML_NS_R</span><span class='comma'>,</span> <span class='symbol'>:r:embed</span><span class='tstring_end'>'</span></span><span class='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>rId1</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>a:stretch</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>a:fillRect</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> - <span class='rbrace'>}</span> - <span class='rbrace'>}</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>xdr:spPr</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>a:xfrm</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>a:off</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:x</span><span class='op'>=></span><span class='int'>0</span><span class='comma'>,</span> <span class='symbol'>:y</span><span class='op'>=></span><span class='int'>0</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>a:ext</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:cx</span><span class='op'>=></span><span class='int'>2336800</span><span class='comma'>,</span> <span class='symbol'>:cy</span><span class='op'>=></span><span class='int'>2161540</span><span class='rparen'>)</span> - <span class='rbrace'>}</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>a:prstGeom</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:prst</span><span class='op'>=></span><span class='symbol'>:rect</span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>a:avLst</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> - <span class='rbrace'>}</span> - <span class='rbrace'>}</span> - <span class='rbrace'>}</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:pic'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:nvPicPr'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:cNvPr'</span><span class='comma token'>,</span> <span class='symbol val'>:id=</span><span class='gt op'>></span><span class='string val'>"2"</span><span class='comma token'>,</span> <span class='symbol val'>:name=</span><span class='gt op'>></span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='symbol val'>:descr=</span><span class='gt op'>></span><span class='descr identifier id'>descr</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:cNvPicPr'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'a:picLocks'</span><span class='comma token'>,</span> <span class='symbol val'>:noChangeAspect=</span><span class='gt op'>></span><span class='integer val'>1</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:blipFill'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'a:blip'</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:r'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS_R constant id'>XML_NS_R</span><span class='comma token'>,</span> <span class='symbol val'>:'r:embed'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='string val'>"rId1"</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'a:stretch'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'a:fillRect'</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:spPr'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'a:xfrm'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'a:off'</span><span class='comma token'>,</span> <span class='symbol val'>:x=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='comma token'>,</span> <span class='symbol val'>:y=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'a:ext'</span><span class='comma token'>,</span> <span class='symbol val'>:cx=</span><span class='gt op'>></span><span class='integer val'>2336800</span><span class='comma token'>,</span> <span class='symbol val'>:cy=</span><span class='gt op'>></span><span class='integer val'>2161540</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'a:prstGeom'</span><span class='comma token'>,</span> <span class='symbol val'>:prst=</span><span class='gt op'>></span><span class='symbol val'>:rect</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'a:avLst'</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1468,8 +1515,9 @@ rowOff</p> </p><div class="docstring"> <div class="discussion"> - -<p>providing access to the anchor's width attribute</p> + <p> +providing access to the anchor’s width attribute +</p> </div> @@ -1512,9 +1560,10 @@ rowOff</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 89</span> -<span class='kw'>def</span> <span class='id width'>width</span> - <span class='ivar'>@anchor</span><span class='period'>.</span><span class='id width'>width</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='width identifier id'>width</span> + <span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='width identifier id'>width</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1556,9 +1605,10 @@ rowOff</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 94</span> -<span class='kw'>def</span> <span class='id width='>width=</span><span class='lparen'>(</span><span class='id v'>v</span><span class='rparen'>)</span> - <span class='ivar'>@anchor</span><span class='period'>.</span><span class='id width'>width</span> <span class='op'>=</span> <span class='id v'>v</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='width= identifier id'>width=</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='width identifier id'>width</span> <span class='assign token'>=</span> <span class='v identifier id'>v</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1569,9 +1619,9 @@ rowOff</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:36 2011 by + Generated on Sun Nov 27 18:05:18 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/Pie3DChart.html b/doc/Axlsx/Pie3DChart.html index dd55e82e..e7754542 100644 --- a/doc/Axlsx/Pie3DChart.html +++ b/doc/Axlsx/Pie3DChart.html @@ -96,9 +96,10 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>The Pie3DChart is a three dimentional piechart (who would have guessed?) -that you can add to your worksheet.</p> + <p> +The Pie3DChart is a three dimentional piechart (who would have guessed?) +that you can add to your worksheet. +</p> </div> @@ -160,8 +161,9 @@ that you can add to your worksheet.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a new pie chart object.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new pie chart object. +</p> </div></span> </li> @@ -183,8 +185,9 @@ that you can add to your worksheet.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the pie chart.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the pie chart. +</p> </div></span> </li> @@ -215,8 +218,9 @@ that you can add to your worksheet.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new pie chart object</p> + <p> +Creates a new pie chart object +</p> </div> @@ -235,8 +239,9 @@ that you can add to your worksheet.</p> — - <div class='inline'> -<p>The workbook that owns this chart.</p> + <div class='inline'><p> +The workbook that owns this chart. +</p> </div> </li> @@ -253,8 +258,9 @@ that you can add to your worksheet.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -387,11 +393,12 @@ that you can add to your worksheet.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pie_3D_chart.rb', line 24</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id frame'>frame</span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='kw'>super</span><span class='lparen'>(</span><span class='id frame'>frame</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> - <span class='ivar'>@series_type</span> <span class='op'>=</span> <span class='const'>PieSeries</span> - <span class='ivar'>@view3D</span> <span class='op'>=</span> <span class='const'>View3D</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='symbol'>:rotX</span><span class='op'>=></span><span class='int'>30</span><span class='comma'>,</span> <span class='symbol'>:perspective</span><span class='op'>=></span><span class='int'>30</span><span class='rbrace'>}</span><span class='period'>.</span><span class='id merge'>merge</span><span class='lparen'>(</span><span class='id options'>options</span><span class='rparen'>)</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='frame identifier id'>frame</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='frame identifier id'>frame</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='@series_type ivar id'>@series_type</span> <span class='assign token'>=</span> <span class='PieSeries constant id'>PieSeries</span> + <span class='@view3D ivar id'>@view3D</span> <span class='assign token'>=</span> <span class='View3D constant id'>View3D</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='lbrace token'>{</span><span class='symbol val'>:rotX=</span><span class='gt op'>></span><span class='integer val'>30</span><span class='comma token'>,</span> <span class='symbol val'>:perspective=</span><span class='gt op'>></span><span class='integer val'>30</span><span class='rbrace token'>}</span><span class='dot token'>.</span><span class='merge identifier id'>merge</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='rparen token'>)</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -413,8 +420,9 @@ that you can add to your worksheet.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the pie chart</p> + <p> +Serializes the pie chart +</p> </div> @@ -453,14 +461,15 @@ that you can add to your worksheet.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pie_3D_chart.rb', line 32</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span> - <span class='kw'>super</span><span class='lparen'>(</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id xml'>xml</span><span class='op'>|</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:pie3DChart</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:varyColors</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='int'>1</span><span class='rparen'>)</span> - <span class='ivar'>@series</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id ser'>ser</span><span class='op'>|</span> <span class='id ser'>ser</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> <span class='rbrace'>}</span> - <span class='rbrace'>}</span> - <span class='kw'>end</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span> + <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:pie3DChart'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:varyColors'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='integer val'>1</span><span class='rparen token'>)</span> + <span class='@series ivar id'>@series</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='ser identifier id'>ser</span><span class='bitor op'>|</span> <span class='ser identifier id'>ser</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -471,9 +480,9 @@ that you can add to your worksheet.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:38 2011 by + Generated on Sun Nov 27 18:05:02 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/PieSeries.html b/doc/Axlsx/PieSeries.html index 312c62b8..37d077e8 100644 --- a/doc/Axlsx/PieSeries.html +++ b/doc/Axlsx/PieSeries.html @@ -99,14 +99,16 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage series is to use Chart#add_series</p> + <div class='inline'><p> +The recommended way to manage series is to use Chart#add_series +</p> </div> </div> - -<p>A PieSeries defines the data and labels and explosion for pie charts -series.</p> +<p> +A PieSeries defines the data and labels and explosion for pie charts +series. +</p> </div> @@ -151,8 +153,9 @@ series.</p> - <span class="summary_desc"><div class='inline'> -<p>The data for this series.</p> + <span class="summary_desc"><div class='inline'><p> +The data for this series. +</p> </div></span> </li> @@ -177,8 +180,9 @@ series.</p> - <span class="summary_desc"><div class='inline'> -<p>The explosion for this series.</p> + <span class="summary_desc"><div class='inline'><p> +The explosion for this series. +</p> </div></span> </li> @@ -203,8 +207,9 @@ series.</p> - <span class="summary_desc"><div class='inline'> -<p>The labels for this series.</p> + <span class="summary_desc"><div class='inline'><p> +The labels for this series. +</p> </div></span> </li> @@ -249,8 +254,9 @@ series.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a new series.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new series. +</p> </div></span> </li> @@ -272,8 +278,9 @@ series.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the series.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the series. +</p> </div></span> </li> @@ -304,8 +311,9 @@ series.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new series</p> + <p> +Creates a new series +</p> </div> @@ -337,8 +345,9 @@ series.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -409,12 +418,13 @@ series.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pie_series.rb', line 26</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id chart'>chart</span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='ivar'>@explosion</span> <span class='op'>=</span> <span class='kw'>nil</span> - <span class='kw'>super</span><span class='lparen'>(</span><span class='id chart'>chart</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id labels'>labels</span> <span class='op'>=</span> <span class='const'>CatAxisData</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:labels</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:labels</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id data'>data</span> <span class='op'>=</span> <span class='const'>ValAxisData</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:data</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:data</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='chart identifier id'>chart</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@explosion ivar id'>@explosion</span> <span class='assign token'>=</span> <span class='nil nil kw'>nil</span> + <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='chart identifier id'>chart</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='labels identifier id'>labels</span> <span class='assign token'>=</span> <span class='CatAxisData constant id'>CatAxisData</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:labels</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:labels</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='data identifier id'>data</span> <span class='assign token'>=</span> <span class='ValAxisData constant id'>ValAxisData</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:data</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:data</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -437,8 +447,9 @@ series.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The data for this series.</p> + <p> +The data for this series. +</p> </div> @@ -472,9 +483,10 @@ series.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pie_series.rb', line 10</span> -<span class='kw'>def</span> <span class='id data'>data</span> - <span class='ivar'>@data</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='data identifier id'>data</span> + <span class='@data ivar id'>@data</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -492,8 +504,9 @@ series.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The explosion for this series</p> + <p> +The explosion for this series +</p> </div> @@ -527,9 +540,10 @@ series.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pie_series.rb', line 18</span> -<span class='kw'>def</span> <span class='id explosion'>explosion</span> - <span class='ivar'>@explosion</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='explosion identifier id'>explosion</span> + <span class='@explosion ivar id'>@explosion</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -547,8 +561,9 @@ series.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The labels for this series.</p> + <p> +The labels for this series. +</p> </div> @@ -582,9 +597,10 @@ series.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pie_series.rb', line 14</span> -<span class='kw'>def</span> <span class='id labels'>labels</span> - <span class='ivar'>@labels</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='labels identifier id'>labels</span> + <span class='@labels ivar id'>@labels</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -606,8 +622,9 @@ series.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the series</p> + <p> +Serializes the series +</p> </div> @@ -626,8 +643,9 @@ series.</p> — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -665,13 +683,14 @@ series.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pie_series.rb', line 39</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='kw'>super</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id xml_inner'>xml_inner</span><span class='op'>|</span> - <span class='id xml_inner'>xml_inner</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:explosion</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@explosion</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@explosion</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='ivar'>@labels</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml_inner'>xml_inner</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@labels</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='ivar'>@data</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml_inner'>xml_inner</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@data</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='kw'>end</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml_inner identifier id'>xml_inner</span><span class='bitor op'>|</span> + <span class='xml_inner identifier id'>xml_inner</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:explosion'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@explosion ivar id'>@explosion</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@explosion ivar id'>@explosion</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='@labels ivar id'>@labels</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml_inner identifier id'>xml_inner</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@labels ivar id'>@labels</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='@data ivar id'>@data</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml_inner identifier id'>xml_inner</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@data ivar id'>@data</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -682,9 +701,9 @@ series.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:38 2011 by + Generated on Sun Nov 27 18:05:16 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/RegexValidator.html b/doc/Axlsx/RegexValidator.html index 398202ce..93b584b3 100644 --- a/doc/Axlsx/RegexValidator.html +++ b/doc/Axlsx/RegexValidator.html @@ -94,8 +94,9 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>Validates the value against the regular expression provided.</p> + <p> +Validates the value against the regular expression provided. +</p> </div> @@ -173,9 +174,10 @@ — - <div class='inline'> -<p>The name of what is being validated. This is included in the output when -the value is invalid</p> + <div class='inline'><p> +The name of what is being validated. This is included in the output when +the value is invalid +</p> </div> </li> @@ -190,8 +192,9 @@ the value is invalid</p> — - <div class='inline'> -<p>The regular expression to evaluate</p> + <div class='inline'><p> +The regular expression to evaluate +</p> </div> </li> @@ -206,8 +209,9 @@ the value is invalid</p> — - <div class='inline'> -<p>The value to validate.</p> + <div class='inline'><p> +The value to validate. +</p> </div> </li> @@ -241,9 +245,10 @@ the value is invalid</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 21</span> -<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id validate'>validate</span><span class='lparen'>(</span><span class='id name'>name</span><span class='comma'>,</span> <span class='id regex'>regex</span><span class='comma'>,</span> <span class='id v'>v</span><span class='rparen'>)</span> - <span class='id raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='lparen'>(</span><span class='const'>ERR_REGEX</span> <span class='op'>%</span> <span class='lbracket'>[</span><span class='id v'>v</span><span class='period'>.</span><span class='id inspect'>inspect</span><span class='comma'>,</span> <span class='id regex'>regex</span><span class='period'>.</span><span class='id to_s'>to_s</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='lparen'>(</span><span class='id v'>v</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:=~</span><span class='rparen'>)</span> <span class='op'>&&</span> <span class='id v'>v</span> <span class='op'>=~</span> <span class='id regex'>regex</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='regex identifier id'>regex</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='lparen token'>(</span><span class='ERR_REGEX constant id'>ERR_REGEX</span> <span class='mod op'>%</span> <span class='lbrack token'>[</span><span class='v identifier id'>v</span><span class='dot token'>.</span><span class='inspect identifier id'>inspect</span><span class='comma token'>,</span> <span class='regex identifier id'>regex</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span><span class='lparen token'>(</span><span class='symbol val'>:=~</span><span class='rparen token'>)</span> <span class='andop op'>&&</span> <span class='v identifier id'>v</span> <span class='match op'>=~</span> <span class='regex identifier id'>regex</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -254,9 +259,9 @@ the value is invalid</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:37 2011 by + Generated on Sun Nov 27 18:05:06 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/Relationship.html b/doc/Axlsx/Relationship.html index e2fb7a6d..1c2499b2 100644 --- a/doc/Axlsx/Relationship.html +++ b/doc/Axlsx/Relationship.html @@ -97,13 +97,15 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>Packages automatcially manage relationships.</p> + <div class='inline'><p> +Packages automatcially manage relationships. +</p> </div> </div> - -<p>A relationship defines a reference between package parts.</p> +<p> +A relationship defines a reference between package parts. +</p> </div> @@ -135,8 +137,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The location of the relationship target.</p> + <span class="summary_desc"><div class='inline'><p> +The location of the relationship target. +</p> </div></span> </li> @@ -161,8 +164,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The type of relationship.</p> + <span class="summary_desc"><div class='inline'><p> +The type of relationship. +</p> </div></span> </li> @@ -199,8 +203,9 @@ - <span class="summary_desc"><div class='inline'> -<p>A new instance of Relationship.</p> + <span class="summary_desc"><div class='inline'><p> +A new instance of Relationship. +</p> </div></span> </li> @@ -222,8 +227,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Serializes the relationship.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the relationship. +</p> </div></span> </li> @@ -244,8 +250,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>A new instance of Relationship</p> + <p> +A new instance of Relationship +</p> </div> @@ -267,10 +274,11 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/rels/relationship.rb', line 24</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id type'>type</span><span class='comma'>,</span> <span class='id target'>target</span><span class='rparen'>)</span> - <span class='kw'>self</span><span class='period'>.</span><span class='const'>Target</span><span class='op'>=</span><span class='id target'>target</span> - <span class='kw'>self</span><span class='period'>.</span><span class='const'>Type</span><span class='op'>=</span><span class='id type'>type</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='type identifier id'>type</span><span class='comma token'>,</span> <span class='target identifier id'>target</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='Target constant id'>Target</span><span class='assign token'>=</span><span class='target identifier id'>target</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='Type constant id'>Type</span><span class='assign token'>=</span><span class='type identifier id'>type</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -293,8 +301,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>The location of the relationship target</p> + <p> +The location of the relationship target +</p> </div> @@ -328,9 +337,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/rels/relationship.rb', line 8</span> -<span class='kw'>def</span> <span class='const'>Target</span> - <span class='ivar'>@Target</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='Target constant id'>Target</span> + <span class='@Target ivar id'>@Target</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -351,13 +361,15 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>Supported types are defined as constants in Axlsx:</p> + <div class='inline'><p> +Supported types are defined as constants in Axlsx: +</p> </div> </div> - -<p>The type of relationship</p> +<p> +The type of relationship +</p> </div> @@ -416,9 +428,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/rels/relationship.rb', line 23</span> -<span class='kw'>def</span> <span class='const'>Type</span> - <span class='ivar'>@Type</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='Type constant id'>Type</span> + <span class='@Type ivar id'>@Type</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -440,8 +453,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the relationship</p> + <p> +Serializes the relationship +</p> </div> @@ -460,8 +474,9 @@ — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -476,8 +491,9 @@ — - <div class='inline'> -<p>the reference id of the object.</p> + <div class='inline'><p> +the reference id of the object. +</p> </div> </li> @@ -513,11 +529,12 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/rels/relationship.rb', line 38</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='comma'>,</span> <span class='id rId'>rId</span><span class='rparen'>)</span> - <span class='id h'>h</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id instance_values'>instance_values</span> - <span class='id h'>h</span><span class='lbracket'>[</span><span class='symbol'>:Id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id rId'>rId</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='const'>Relationship</span><span class='lparen'>(</span><span class='id h'>h</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='comma token'>,</span> <span class='rId identifier id'>rId</span><span class='rparen token'>)</span> + <span class='h identifier id'>h</span> <span class='assign token'>=</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span> + <span class='h identifier id'>h</span><span class='lbrack token'>[</span><span class='symbol val'>:Id</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rId identifier id'>rId</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='Relationship constant id'>Relationship</span><span class='lparen token'>(</span><span class='h identifier id'>h</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -528,9 +545,9 @@ </div> <div id="footer"> - Generated on Sat Nov 26 13:16:38 2011 by + Generated on Sun Nov 27 18:05:13 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/Relationships.html b/doc/Axlsx/Relationships.html index b68eff83..50312a07 100644 --- a/doc/Axlsx/Relationships.html +++ b/doc/Axlsx/Relationships.html @@ -99,14 +99,16 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The package automatically manages releationships.</p> + <div class='inline'><p> +The package automatically manages releationships. +</p> </div> </div> - -<p>Relationships are a collection of Relations that define how package parts -are related.</p> +<p> +Relationships are a collection of Relations that define how package parts +are related. +</p> </div> @@ -157,8 +159,9 @@ are related.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a new Relationships collection based on SimpleTypedList.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new Relationships collection based on SimpleTypedList. +</p> </div></span> </li> @@ -180,8 +183,9 @@ are related.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the relationships document.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the relationships document. +</p> </div></span> </li> @@ -207,8 +211,9 @@ are related.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new Relationships collection based on SimpleTypedList</p> + <p> +Creates a new Relationships collection based on SimpleTypedList +</p> </div> @@ -229,9 +234,10 @@ are related.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/rels/relationships.rb', line 9</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span> - <span class='kw'>super</span> <span class='const'>Relationship</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span> + <span class='super super kw'>super</span> <span class='Relationship constant id'>Relationship</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -263,8 +269,9 @@ are related.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the relationships document.</p> + <p> +Serializes the relationships document. +</p> </div> @@ -303,14 +310,15 @@ are related.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/rels/relationships.rb', line 15</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='rparen'>)</span> - <span class='id builder'>builder</span> <span class='op'>=</span> <span class='const'>Nokogiri</span><span class='op'>::</span><span class='const'>XML</span><span class='op'>::</span><span class='const'>Builder</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='symbol'>:encoding</span> <span class='op'>=></span> <span class='const'>ENCODING</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id xml'>xml</span><span class='op'>|</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='const'>Relationships</span><span class='lparen'>(</span><span class='symbol'>:xmlns</span> <span class='op'>=></span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>RELS_R</span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id each_with_index'>each_with_index</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id rel'>rel</span><span class='comma'>,</span> <span class='id index'>index</span><span class='op'>|</span> <span class='id rel'>rel</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>rId</span><span class='embexpr_beg'>#{</span><span class='id index'>index</span><span class='op'>+</span><span class='int'>1</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='rbrace'>}</span> - <span class='rbrace'>}</span> - <span class='kw'>end</span> - <span class='id builder'>builder</span><span class='period'>.</span><span class='id to_xml'>to_xml</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='rparen token'>)</span> + <span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='Relationships constant id'>Relationships</span><span class='lparen token'>(</span><span class='symbol val'>:xmlns</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='RELS_R constant id'>RELS_R</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='each_with_index identifier id'>each_with_index</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='rel identifier id'>rel</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span> <span class='rel identifier id'>rel</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='comma token'>,</span> <span class='dstring node'>"rId#{index+1}"</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -321,9 +329,9 @@ are related.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:38 2011 by + Generated on Sun Nov 27 18:05:18 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/RestrictionValidator.html b/doc/Axlsx/RestrictionValidator.html index 32f5900d..8d865072 100644 --- a/doc/Axlsx/RestrictionValidator.html +++ b/doc/Axlsx/RestrictionValidator.html @@ -94,8 +94,9 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>Validate a value against a specific list of allowed values.</p> + <p> +Validate a value against a specific list of allowed values. +</p> </div> @@ -132,8 +133,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Perform validation.</p> + <span class="summary_desc"><div class='inline'><p> +Perform validation. +</p> </div></span> </li> @@ -157,8 +159,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Perform validation</p> + <p> +Perform validation +</p> </div> @@ -177,8 +180,9 @@ — - <div class='inline'> -<p>The name of what is being validatied. This is included in the error message</p> + <div class='inline'><p> +The name of what is being validatied. This is included in the error message +</p> </div> </li> @@ -193,8 +197,9 @@ — - <div class='inline'> -<p>The list of choices to validate against</p> + <div class='inline'><p> +The list of choices to validate against +</p> </div> </li> @@ -209,8 +214,9 @@ — - <div class='inline'> -<p>The value to be validated</p> + <div class='inline'><p> +The value to be validated +</p> </div> </li> @@ -228,8 +234,9 @@ — - <div class='inline'> -<p>true if validation succeeds.</p> + <div class='inline'><p> +true if validation succeeds. +</p> </div> </li> @@ -246,8 +253,9 @@ — - <div class='inline'> -<p>Raised if the value provided is not in the list of choices.</p> + <div class='inline'><p> +Raised if the value provided is not in the list of choices. +</p> </div> </li> @@ -268,10 +276,11 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 10</span> -<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id validate'>validate</span><span class='lparen'>(</span><span class='id name'>name</span><span class='comma'>,</span> <span class='id choices'>choices</span><span class='comma'>,</span> <span class='id v'>v</span><span class='rparen'>)</span> - <span class='id raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='lparen'>(</span><span class='const'>ERR_RESTRICTION</span> <span class='op'>%</span> <span class='lbracket'>[</span><span class='id v'>v</span><span class='period'>.</span><span class='id to_s'>to_s</span><span class='comma'>,</span> <span class='id name'>name</span><span class='comma'>,</span> <span class='id choices'>choices</span><span class='period'>.</span><span class='id inspect'>inspect</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id choices'>choices</span><span class='period'>.</span><span class='id include?'>include?</span><span class='lparen'>(</span><span class='id v'>v</span><span class='rparen'>)</span> - <span class='kw'>true</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='choices identifier id'>choices</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='lparen token'>(</span><span class='ERR_RESTRICTION constant id'>ERR_RESTRICTION</span> <span class='mod op'>%</span> <span class='lbrack token'>[</span><span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='comma token'>,</span> <span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='choices identifier id'>choices</span><span class='dot token'>.</span><span class='inspect identifier id'>inspect</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='choices identifier id'>choices</span><span class='dot token'>.</span><span class='include? fid id'>include?</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='true true kw'>true</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -282,9 +291,9 @@ </div> <div id="footer"> - Generated on Sat Nov 26 13:16:37 2011 by + Generated on Sun Nov 27 18:05:09 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/Row.html b/doc/Axlsx/Row.html index 84687f5e..ecd9a49a 100644 --- a/doc/Axlsx/Row.html +++ b/doc/Axlsx/Row.html @@ -97,13 +97,15 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage rows and cells is to use Worksheet#add_row</p> + <div class='inline'><p> +The recommended way to manage rows and cells is to use Worksheet#add_row +</p> </div> </div> - -<p>A Row is a single row in a worksheet.</p> +<p> +A Row is a single row in a worksheet. +</p> </div> @@ -142,8 +144,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The cells this row holds.</p> + <span class="summary_desc"><div class='inline'><p> +The cells this row holds. +</p> </div></span> </li> @@ -168,8 +171,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The worksheet this row belongs to.</p> + <span class="summary_desc"><div class='inline'><p> +The worksheet this row belongs to. +</p> </div></span> </li> @@ -204,9 +208,10 @@ - <span class="summary_desc"><div class='inline'> -<p>Adds a singel sell to the row based on the data provided and updates the -worksheet's autofit data.</p> + <span class="summary_desc"><div class='inline'><p> +Adds a singel sell to the row based on the data provided and updates the +worksheet’s autofit data. +</p> </div></span> </li> @@ -228,8 +233,9 @@ worksheet's autofit data.</p> - <span class="summary_desc"><div class='inline'> -<p>The index of this row in the worksheet.</p> + <span class="summary_desc"><div class='inline'><p> +The index of this row in the worksheet. +</p> </div></span> </li> @@ -253,8 +259,33 @@ worksheet's autofit data.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a new row.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new row. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#style%3D-instance_method" title="#style= (instance method)">- (Object) <strong>style=</strong>(style) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +sets the style for every cell in this row. +</p> </div></span> </li> @@ -276,8 +307,9 @@ worksheet's autofit data.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the row.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the row. +</p> </div></span> </li> @@ -298,17 +330,19 @@ worksheet's autofit data.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new row. New Cell objects are created based on the values, types + <p> +Creates a new row. New Cell objects are created based on the values, types and style options. A new cell is created for each item in the values array. -style and types options are applied as follows:</p> - -<pre class="code">If the types option is defined and is a symbol it is applied to all the cells created. -If the types option is an array, cell types are applied by index for each cell -If the types option is not set, the cell will automatically determine its type. -If the style option is defined and is an Integer, it is applied to all cells created. -If the style option is an array, style is applied by index for each cell. -If the style option is not defined, the default style (0) is applied to each cell.</pre> +style and types options are applied as follows: +</p> +<pre class="code"> + <span class='If constant id'>If</span> <span class='the identifier id'>the</span> <span class='types identifier id'>types</span> <span class='option identifier id'>option</span> <span class='is identifier id'>is</span> <span class='defined identifier id'>defined</span> <span class='and and kw'>and</span> <span class='is identifier id'>is</span> <span class='a identifier id'>a</span> <span class='symbol identifier id'>symbol</span> <span class='it identifier id'>it</span> <span class='is identifier id'>is</span> <span class='applied identifier id'>applied</span> <span class='to identifier id'>to</span> <span class='all identifier id'>all</span> <span class='the identifier id'>the</span> <span class='cells identifier id'>cells</span> <span class='created identifier id'>created</span><span class='dot token'>.</span> + <span class='If constant id'>If</span> <span class='the identifier id'>the</span> <span class='types identifier id'>types</span> <span class='option identifier id'>option</span> <span class='is identifier id'>is</span> <span class='an identifier id'>an</span> <span class='array identifier id'>array</span><span class='comma token'>,</span> <span class='cell identifier id'>cell</span> <span class='types identifier id'>types</span> <span class='are identifier id'>are</span> <span class='applied identifier id'>applied</span> <span class='by identifier id'>by</span> <span class='index identifier id'>index</span> <span class='for for kw'>for</span> <span class='each identifier id'>each</span> <span class='cell identifier id'>cell</span> + <span class='If constant id'>If</span> <span class='the identifier id'>the</span> <span class='types identifier id'>types</span> <span class='option identifier id'>option</span> <span class='is identifier id'>is</span> <span class='not not kw'>not</span> <span class='set identifier id'>set</span><span class='comma token'>,</span> <span class='the identifier id'>the</span> <span class='cell identifier id'>cell</span> <span class='will identifier id'>will</span> <span class='automatically identifier id'>automatically</span> <span class='determine identifier id'>determine</span> <span class='its identifier id'>its</span> <span class='type identifier id'>type</span><span class='dot token'>.</span> + <span class='If constant id'>If</span> <span class='the identifier id'>the</span> <span class='style identifier id'>style</span> <span class='option identifier id'>option</span> <span class='is identifier id'>is</span> <span class='defined identifier id'>defined</span> <span class='and and kw'>and</span> <span class='is identifier id'>is</span> <span class='an identifier id'>an</span> <span class='Integer constant id'>Integer</span><span class='comma token'>,</span> <span class='it identifier id'>it</span> <span class='is identifier id'>is</span> <span class='applied identifier id'>applied</span> <span class='to identifier id'>to</span> <span class='all identifier id'>all</span> <span class='cells identifier id'>cells</span> <span class='created identifier id'>created</span><span class='dot token'>.</span> + <span class='If constant id'>If</span> <span class='the identifier id'>the</span> <span class='style identifier id'>style</span> <span class='option identifier id'>option</span> <span class='is identifier id'>is</span> <span class='an identifier id'>an</span> <span class='array identifier id'>array</span><span class='comma token'>,</span> <span class='style identifier id'>style</span> <span class='is identifier id'>is</span> <span class='applied identifier id'>applied</span> <span class='by identifier id'>by</span> <span class='index identifier id'>index</span> <span class='for for kw'>for</span> <span class='each identifier id'>each</span> <span class='cell identifier id'>cell</span><span class='dot token'>.</span> + <span class='If constant id'>If</span> <span class='the identifier id'>the</span> <span class='style identifier id'>style</span> <span class='option identifier id'>option</span> <span class='is identifier id'>is</span> <span class='not not kw'>not</span> <span class='defined identifier id'>defined</span><span class='comma token'>,</span> <span class='the identifier id'>the</span> <span class='default identifier id'>default</span> <span class='style identifier id'>style</span> <span class='lparen token'>(</span><span class='integer val'>0</span><span class='rparen token'>)</span> <span class='is identifier id'>is</span> <span class='applied identifier id'>applied</span> <span class='to identifier id'>to</span> <span class='each identifier id'>each</span> <span class='cell identifier id'>cell</span><span class='dot token'>.</span> +</pre> </div> @@ -340,8 +374,9 @@ If the style option is not defined, the default style (0) is applied to each cel — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -414,12 +449,13 @@ If the style option is not defined, the default style (0) is applied to each cel <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 29</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id worksheet'>worksheet</span><span class='comma'>,</span> <span class='id values'>values</span><span class='op'>=</span><span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id worksheet'>worksheet</span> <span class='op'>=</span> <span class='id worksheet'>worksheet</span> - <span class='ivar'>@cells</span> <span class='op'>=</span> <span class='const'>SimpleTypedList</span><span class='period'>.</span><span class='id new'>new</span> <span class='const'>Cell</span> - <span class='ivar'>@worksheet</span><span class='period'>.</span><span class='id rows'>rows</span> <span class='op'><<</span> <span class='kw'>self</span> - <span class='id array_to_cells'>array_to_cells</span><span class='lparen'>(</span><span class='id values'>values</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='worksheet identifier id'>worksheet</span><span class='comma token'>,</span> <span class='values identifier id'>values</span><span class='assign token'>=</span><span class='lbrack token'>[</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='worksheet identifier id'>worksheet</span> <span class='assign token'>=</span> <span class='worksheet identifier id'>worksheet</span> + <span class='@cells ivar id'>@cells</span> <span class='assign token'>=</span> <span class='SimpleTypedList constant id'>SimpleTypedList</span><span class='dot token'>.</span><span class='new identifier id'>new</span> <span class='Cell constant id'>Cell</span> + <span class='@worksheet ivar id'>@worksheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span> <span class='lshft op'><<</span> <span class='self self kw'>self</span> + <span class='array_to_cells identifier id'>array_to_cells</span><span class='lparen token'>(</span><span class='values identifier id'>values</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -442,8 +478,9 @@ If the style option is not defined, the default style (0) is applied to each cel </p><div class="docstring"> <div class="discussion"> - -<p>The cells this row holds</p> + <p> +The cells this row holds +</p> </div> @@ -477,9 +514,10 @@ If the style option is not defined, the default style (0) is applied to each cel <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 13</span> -<span class='kw'>def</span> <span class='id cells'>cells</span> - <span class='ivar'>@cells</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='cells identifier id'>cells</span> + <span class='@cells ivar id'>@cells</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -497,8 +535,9 @@ If the style option is not defined, the default style (0) is applied to each cel </p><div class="docstring"> <div class="discussion"> - -<p>The worksheet this row belongs to</p> + <p> +The worksheet this row belongs to +</p> </div> @@ -532,9 +571,10 @@ If the style option is not defined, the default style (0) is applied to each cel <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 9</span> -<span class='kw'>def</span> <span class='id worksheet'>worksheet</span> - <span class='ivar'>@worksheet</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='worksheet identifier id'>worksheet</span> + <span class='@worksheet ivar id'>@worksheet</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -556,9 +596,10 @@ If the style option is not defined, the default style (0) is applied to each cel </p><div class="docstring"> <div class="discussion"> - -<p>Adds a singel sell to the row based on the data provided and updates the -worksheet's autofit data.</p> + <p> +Adds a singel sell to the row based on the data provided and updates the +worksheet’s autofit data. +</p> </div> @@ -594,11 +635,12 @@ worksheet's autofit data.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 51</span> -<span class='kw'>def</span> <span class='id add_cell'>add_cell</span><span class='lparen'>(</span><span class='id value'>value</span><span class='op'>=</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='id c'>c</span> <span class='op'>=</span> <span class='const'>Cell</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id value'>value</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> - <span class='id update_auto_fit_data'>update_auto_fit_data</span> - <span class='id c'>c</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='add_cell identifier id'>add_cell</span><span class='lparen token'>(</span><span class='value identifier id'>value</span><span class='assign token'>=</span><span class='string val'>""</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='c identifier id'>c</span> <span class='assign token'>=</span> <span class='Cell constant id'>Cell</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='comma token'>,</span> <span class='value identifier id'>value</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='update_auto_fit_data identifier id'>update_auto_fit_data</span> + <span class='c identifier id'>c</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -613,8 +655,9 @@ worksheet's autofit data.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The index of this row in the worksheet</p> + <p> +The index of this row in the worksheet +</p> </div> @@ -648,9 +691,57 @@ worksheet's autofit data.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 38</span> -<span class='kw'>def</span> <span class='id index'>index</span> - <span class='id worksheet'>worksheet</span><span class='period'>.</span><span class='id rows'>rows</span><span class='period'>.</span><span class='id index'>index</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='index identifier id'>index</span> + <span class='worksheet identifier id'>worksheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="style=-instance_method"> + + - (<tt>Object</tt>) <strong>style=</strong>(style) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +sets the style for every cell in this row +</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +58 +59 +60 +61 +62 +63</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 58</span> + +<span class='def def kw'>def</span> <span class='style= identifier id'>style=</span><span class='lparen token'>(</span><span class='style identifier id'>style</span><span class='rparen token'>)</span> + <span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='each_with_index identifier id'>each_with_index</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span> <span class='cell identifier id'>cell</span><span class='comma token'>,</span> <span class='index identifier id'>index</span> <span class='bitor op'>|</span> + <span class='s identifier id'>s</span> <span class='assign token'>=</span> <span class='style identifier id'>style</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Array constant id'>Array</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='style identifier id'>style</span><span class='lbrack token'>[</span><span class='index identifier id'>index</span><span class='rbrack token'>]</span> <span class='colon op'>:</span> <span class='style identifier id'>style</span> + <span class='cell identifier id'>cell</span><span class='dot token'>.</span><span class='style identifier id'>style</span> <span class='assign token'>=</span> <span class='s identifier id'>s</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -665,8 +756,9 @@ worksheet's autofit data.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the row</p> + <p> +Serializes the row +</p> </div> @@ -685,8 +777,9 @@ worksheet's autofit data.</p> — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -720,9 +813,10 @@ worksheet's autofit data.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 45</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id row'>row</span><span class='lparen'>(</span><span class='symbol'>:r</span> <span class='op'>=></span> <span class='id index'>index</span><span class='op'>+</span><span class='int'>1</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='ivar'>@cells</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id cell'>cell</span><span class='op'>|</span> <span class='id cell'>cell</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> <span class='rbrace'>}</span> <span class='rbrace'>}</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='row identifier id'>row</span><span class='lparen token'>(</span><span class='symbol val'>:r</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='index identifier id'>index</span><span class='plus op'>+</span><span class='integer val'>1</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> <span class='@cells ivar id'>@cells</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='cell identifier id'>cell</span><span class='bitor op'>|</span> <span class='cell identifier id'>cell</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -733,9 +827,9 @@ worksheet's autofit data.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:39 2011 by + Generated on Sun Nov 27 18:05:10 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/Scaling.html b/doc/Axlsx/Scaling.html index e8a6a8be..5878f1d4 100644 --- a/doc/Axlsx/Scaling.html +++ b/doc/Axlsx/Scaling.html @@ -94,8 +94,9 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>The Scaling class defines axis scaling</p> + <p> +The Scaling class defines axis scaling +</p> </div> @@ -127,8 +128,9 @@ - <span class="summary_desc"><div class='inline'> -<p>logarithmic base for a logarithmic axis.</p> + <span class="summary_desc"><div class='inline'><p> +logarithmic base for a logarithmic axis. +</p> </div></span> </li> @@ -153,8 +155,9 @@ - <span class="summary_desc"><div class='inline'> -<p>the maximum scaling.</p> + <span class="summary_desc"><div class='inline'><p> +the maximum scaling. +</p> </div></span> </li> @@ -179,8 +182,9 @@ - <span class="summary_desc"><div class='inline'> -<p>the minimu scaling.</p> + <span class="summary_desc"><div class='inline'><p> +the minimu scaling. +</p> </div></span> </li> @@ -205,8 +209,9 @@ - <span class="summary_desc"><div class='inline'> -<p>the orientation of the axis must be one of [:minMax, :maxMin].</p> + <span class="summary_desc"><div class='inline'><p> +the orientation of the axis must be one of [:minMax, :maxMin]. +</p> </div></span> </li> @@ -243,8 +248,9 @@ - <span class="summary_desc"><div class='inline'> -<p>creates a new Scaling object.</p> + <span class="summary_desc"><div class='inline'><p> +creates a new Scaling object. +</p> </div></span> </li> @@ -266,8 +272,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Serializes the axId.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the axId. +</p> </div></span> </li> @@ -288,8 +295,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>creates a new Scaling object</p> + <p> +creates a new Scaling object +</p> </div> @@ -310,8 +318,9 @@ — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -381,13 +390,14 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/scaling.rb', line 28</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='ivar'>@orientation</span> <span class='op'>=</span> <span class='symbol'>:minMax</span> - <span class='ivar'>@logBase</span><span class='comma'>,</span> <span class='ivar'>@min</span><span class='comma'>,</span> <span class='ivar'>@max</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span> - <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span> - <span class='kw'>end</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@orientation ivar id'>@orientation</span> <span class='assign token'>=</span> <span class='symbol val'>:minMax</span> + <span class='@logBase ivar id'>@logBase</span><span class='comma token'>,</span> <span class='@min ivar id'>@min</span><span class='comma token'>,</span> <span class='@max ivar id'>@max</span> <span class='assign token'>=</span> <span class='nil nil kw'>nil</span><span class='comma token'>,</span> <span class='nil nil kw'>nil</span><span class='comma token'>,</span> <span class='nil nil kw'>nil</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -410,8 +420,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>logarithmic base for a logarithmic axis. must be between 2 and 1000</p> + <p> +logarithmic base for a logarithmic axis. must be between 2 and 1000 +</p> </div> @@ -445,9 +456,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/scaling.rb', line 8</span> -<span class='kw'>def</span> <span class='id logBase'>logBase</span> - <span class='ivar'>@logBase</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='logBase identifier id'>logBase</span> + <span class='@logBase ivar id'>@logBase</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -465,8 +477,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>the maximum scaling</p> + <p> +the maximum scaling +</p> </div> @@ -500,9 +513,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/scaling.rb', line 17</span> -<span class='kw'>def</span> <span class='id max'>max</span> - <span class='ivar'>@max</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='max identifier id'>max</span> + <span class='@max ivar id'>@max</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -520,8 +534,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>the minimu scaling</p> + <p> +the minimu scaling +</p> </div> @@ -555,9 +570,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/scaling.rb', line 21</span> -<span class='kw'>def</span> <span class='id min'>min</span> - <span class='ivar'>@min</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='min identifier id'>min</span> + <span class='@min ivar id'>@min</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -575,8 +591,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>the orientation of the axis must be one of [:minMax, :maxMin]</p> + <p> +the orientation of the axis must be one of [:minMax, :maxMin] +</p> </div> @@ -610,9 +627,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/scaling.rb', line 13</span> -<span class='kw'>def</span> <span class='id orientation'>orientation</span> - <span class='ivar'>@orientation</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='orientation identifier id'>orientation</span> + <span class='@orientation ivar id'>@orientation</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -634,8 +652,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the axId</p> + <p> +Serializes the axId +</p> </div> @@ -654,8 +673,9 @@ — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -694,14 +714,15 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/scaling.rb', line 49</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:scaling</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:logBase</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span> <span class='ivar'>@logBase</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@logBase</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:orientation</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span> <span class='ivar'>@orientation</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@orientation</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:min</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span> <span class='op'>=></span> <span class='ivar'>@min</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@min</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:max</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span> <span class='op'>=></span> <span class='ivar'>@max</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@max</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='rbrace'>}</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:scaling'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:logBase'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span> <span class='@logBase ivar id'>@logBase</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@logBase ivar id'>@logBase</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:orientation'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span> <span class='@orientation ivar id'>@orientation</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@orientation ivar id'>@orientation</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:min'</span><span class='comma token'>,</span> <span class='symbol val'>:val</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='@min ivar id'>@min</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@min ivar id'>@min</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:max'</span><span class='comma token'>,</span> <span class='symbol val'>:val</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='@max ivar id'>@max</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@max ivar id'>@max</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -712,9 +733,9 @@ </div> <div id="footer"> - Generated on Sat Nov 26 13:16:37 2011 by + Generated on Sun Nov 27 18:05:04 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/SerAxis.html b/doc/Axlsx/SerAxis.html index bec08bde..4d5cdef3 100644 --- a/doc/Axlsx/SerAxis.html +++ b/doc/Axlsx/SerAxis.html @@ -96,8 +96,9 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>A SerAxis object defines a series axis</p> + <p> +A SerAxis object defines a series axis +</p> </div> @@ -133,8 +134,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The number of tick lables to skip between labels.</p> + <span class="summary_desc"><div class='inline'><p> +The number of tick lables to skip between labels. +</p> </div></span> </li> @@ -159,8 +161,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The number of tickmarks to be skipped before the next one is rendered.</p> + <span class="summary_desc"><div class='inline'><p> +The number of tickmarks to be skipped before the next one is rendered. +</p> </div></span> </li> @@ -205,8 +208,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Creates a new SerAxis object.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new SerAxis object. +</p> </div></span> </li> @@ -228,8 +232,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Serializes the series axis.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the series axis. +</p> </div></span> </li> @@ -255,8 +260,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new SerAxis object</p> + <p> +Creates a new SerAxis object +</p> </div> @@ -275,8 +281,9 @@ — - <div class='inline'> -<p>the id of this axis. Inherited</p> + <div class='inline'><p> +the id of this axis. Inherited +</p> </div> </li> @@ -291,8 +298,9 @@ — - <div class='inline'> -<p>the id of the perpendicular axis. Inherited</p> + <div class='inline'><p> +the id of the perpendicular axis. Inherited +</p> </div> </li> @@ -309,8 +317,9 @@ — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -333,8 +342,9 @@ <span class="default"> </span> - — <div class='inline'> -<p>Inherited</p> + — <div class='inline'><p> +Inherited +</p> </div> </li> @@ -344,8 +354,9 @@ <span class="default"> </span> - — <div class='inline'> -<p>Inherited</p> + — <div class='inline'><p> +Inherited +</p> </div> </li> @@ -355,8 +366,9 @@ <span class="default"> </span> - — <div class='inline'> -<p>Inherited</p> + — <div class='inline'><p> +Inherited +</p> </div> </li> @@ -396,10 +408,11 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/ser_axis.rb', line 21</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id axId'>axId</span><span class='comma'>,</span> <span class='id crossAx'>crossAx</span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='ivar'>@tickLblSkip</span><span class='comma'>,</span> <span class='ivar'>@tickMarkSkip</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span> - <span class='kw'>super</span><span class='lparen'>(</span><span class='id axId'>axId</span><span class='comma'>,</span> <span class='id crossAx'>crossAx</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='axId identifier id'>axId</span><span class='comma token'>,</span> <span class='crossAx identifier id'>crossAx</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@tickLblSkip ivar id'>@tickLblSkip</span><span class='comma token'>,</span> <span class='@tickMarkSkip ivar id'>@tickMarkSkip</span> <span class='assign token'>=</span> <span class='nil nil kw'>nil</span><span class='comma token'>,</span> <span class='nil nil kw'>nil</span> + <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='axId identifier id'>axId</span><span class='comma token'>,</span> <span class='crossAx identifier id'>crossAx</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -422,8 +435,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>The number of tick lables to skip between labels</p> + <p> +The number of tick lables to skip between labels +</p> </div> @@ -457,9 +471,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/ser_axis.rb', line 7</span> -<span class='kw'>def</span> <span class='id tickLblSkip'>tickLblSkip</span> - <span class='ivar'>@tickLblSkip</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='tickLblSkip identifier id'>tickLblSkip</span> + <span class='@tickLblSkip ivar id'>@tickLblSkip</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -477,8 +492,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>The number of tickmarks to be skipped before the next one is rendered.</p> + <p> +The number of tickmarks to be skipped before the next one is rendered. +</p> </div> @@ -512,9 +528,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/ser_axis.rb', line 11</span> -<span class='kw'>def</span> <span class='id tickMarkSkip'>tickMarkSkip</span> - <span class='ivar'>@tickMarkSkip</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='tickMarkSkip identifier id'>tickMarkSkip</span> + <span class='@tickMarkSkip ivar id'>@tickMarkSkip</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -536,8 +553,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the series axis</p> + <p> +Serializes the series axis +</p> </div> @@ -556,8 +574,9 @@ — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -595,13 +614,14 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/ser_axis.rb', line 35</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:serAx</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='kw'>super</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:tickLblSkip</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@tickLblSkip</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@tickLblSkip</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:tickMarkSkip</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@tickMarkSkip</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@tickMarkSkip</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='rbrace'>}</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:serAx'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:tickLblSkip'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@tickLblSkip ivar id'>@tickLblSkip</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@tickLblSkip ivar id'>@tickLblSkip</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:tickMarkSkip'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@tickMarkSkip ivar id'>@tickMarkSkip</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@tickMarkSkip ivar id'>@tickMarkSkip</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -612,9 +632,9 @@ </div> <div id="footer"> - Generated on Sat Nov 26 13:16:37 2011 by + Generated on Sun Nov 27 18:05:13 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/Series.html b/doc/Axlsx/Series.html index f93a1220..29aca381 100644 --- a/doc/Axlsx/Series.html +++ b/doc/Axlsx/Series.html @@ -97,14 +97,16 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage series is to use Chart#add_series</p> + <div class='inline'><p> +The recommended way to manage series is to use Chart#add_series +</p> </div> </div> - -<p>A Series defines the common series attributes and is the super class for -all concrete series types.</p> +<p> +A Series defines the common series attributes and is the super class for +all concrete series types. +</p> </div> @@ -149,8 +151,9 @@ all concrete series types.</p> - <span class="summary_desc"><div class='inline'> -<p>The chart that owns this series.</p> + <span class="summary_desc"><div class='inline'><p> +The chart that owns this series. +</p> </div></span> </li> @@ -175,8 +178,9 @@ all concrete series types.</p> - <span class="summary_desc"><div class='inline'> -<p>The title of the series.</p> + <span class="summary_desc"><div class='inline'><p> +The title of the series. +</p> </div></span> </li> @@ -211,8 +215,9 @@ all concrete series types.</p> - <span class="summary_desc"><div class='inline'> -<p>The index of this series in the chart's series.</p> + <span class="summary_desc"><div class='inline'><p> +The index of this series in the chart’s series. +</p> </div></span> </li> @@ -236,8 +241,9 @@ all concrete series types.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a new series.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new series. +</p> </div></span> </li> @@ -259,8 +265,9 @@ all concrete series types.</p> - <span class="summary_desc"><div class='inline'> -<p>The order of this series in the chart's series.</p> + <span class="summary_desc"><div class='inline'><p> +The order of this series in the chart’s series. +</p> </div></span> </li> @@ -287,6 +294,30 @@ all concrete series types.</p> </li> + <li class="public "> + <span class="summary_signature"> + + <a href="#to_xml-instance_method" title="#to_xml (instance method)">- (String) <strong>to_xml</strong>(xml) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Serializes the series. +</p> +</div></span> + +</li> + + </ul> @@ -302,8 +333,9 @@ all concrete series types.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new series</p> + <p> +Creates a new series +</p> </div> @@ -335,8 +367,9 @@ all concrete series types.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -391,14 +424,15 @@ all concrete series types.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/series.rb', line 20</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id chart'>chart</span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='ivar'>@order</span> <span class='op'>=</span> <span class='kw'>nil</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id chart'>chart</span> <span class='op'>=</span> <span class='id chart'>chart</span> - <span class='ivar'>@chart</span><span class='period'>.</span><span class='id series'>series</span> <span class='op'><<</span> <span class='kw'>self</span> - <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span> - <span class='kw'>end</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='chart identifier id'>chart</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@order ivar id'>@order</span> <span class='assign token'>=</span> <span class='nil nil kw'>nil</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='chart identifier id'>chart</span> <span class='assign token'>=</span> <span class='chart identifier id'>chart</span> + <span class='@chart ivar id'>@chart</span><span class='dot token'>.</span><span class='series identifier id'>series</span> <span class='lshft op'><<</span> <span class='self self kw'>self</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -421,8 +455,9 @@ all concrete series types.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The chart that owns this series</p> + <p> +The chart that owns this series +</p> </div> @@ -456,9 +491,10 @@ all concrete series types.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/series.rb', line 10</span> -<span class='kw'>def</span> <span class='id chart'>chart</span> - <span class='ivar'>@chart</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='chart identifier id'>chart</span> + <span class='@chart ivar id'>@chart</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -476,8 +512,9 @@ all concrete series types.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The title of the series</p> + <p> +The title of the series +</p> </div> @@ -511,9 +548,10 @@ all concrete series types.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/series.rb', line 14</span> -<span class='kw'>def</span> <span class='id title'>title</span> - <span class='ivar'>@title</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='title identifier id'>title</span> + <span class='@title ivar id'>@title</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -535,8 +573,9 @@ all concrete series types.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The index of this series in the chart's series.</p> + <p> +The index of this series in the chart’s series. +</p> </div> @@ -570,9 +609,10 @@ all concrete series types.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/series.rb', line 31</span> -<span class='kw'>def</span> <span class='id index'>index</span> - <span class='ivar'>@chart</span><span class='period'>.</span><span class='id series'>series</span><span class='period'>.</span><span class='id index'>index</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='index identifier id'>index</span> + <span class='@chart ivar id'>@chart</span><span class='dot token'>.</span><span class='series identifier id'>series</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -587,9 +627,10 @@ all concrete series types.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The order of this series in the chart's series. By default the order is the -index of the series.</p> + <p> +The order of this series in the chart’s series. By default the order +is the index of the series. +</p> </div> @@ -623,9 +664,10 @@ index of the series.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/series.rb', line 38</span> -<span class='kw'>def</span> <span class='id order'>order</span> - <span class='ivar'>@order</span> <span class='op'>||</span> <span class='id index'>index</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='order identifier id'>order</span> + <span class='@order ivar id'>@order</span> <span class='orop op'>||</span> <span class='index identifier id'>index</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -665,7 +707,93 @@ index of the series.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/series.rb', line 43</span> -<span class='kw'>def</span> <span class='id order='>order=</span><span class='lparen'>(</span><span class='id v'>v</span><span class='rparen'>)</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='id validate_unsigned_int'>validate_unsigned_int</span><span class='lparen'>(</span><span class='id v'>v</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='ivar'>@order</span> <span class='op'>=</span> <span class='id v'>v</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='order= identifier id'>order=</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='validate_unsigned_int identifier id'>validate_unsigned_int</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span><span class='semicolon token'>;</span> <span class='@order ivar id'>@order</span> <span class='assign token'>=</span> <span class='v identifier id'>v</span> <span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="to_xml-instance_method"> + + - (<tt>String</tt>) <strong>to_xml</strong>(xml) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Serializes the series +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>xml</span> + + + <span class='type'>(<tt>Nokogiri::XML::Builder</tt>)</span> + + + + — + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> +</div> + + </li> + +</ul> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +60 +61 +62 +63 +64 +65 +66 +67</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/series.rb', line 60</span> + +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:ser'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:idx'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='index identifier id'>index</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:order'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='order identifier id'>order</span> <span class='orop op'>||</span> <span class='index identifier id'>index</span><span class='rparen token'>)</span> + <span class='title identifier id'>title</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='title identifier id'>title</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='yield yield kw'>yield</span> <span class='xml identifier id'>xml</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -676,9 +804,9 @@ index of the series.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:37 2011 by + Generated on Sun Nov 27 18:05:07 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/SeriesTitle.html b/doc/Axlsx/SeriesTitle.html index e809a40e..4cf2cdd9 100644 --- a/doc/Axlsx/SeriesTitle.html +++ b/doc/Axlsx/SeriesTitle.html @@ -96,9 +96,10 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>A series title is a Title with a slightly different serialization than -chart titles.</p> + <p> +A series title is a Title with a slightly different serialization than +chart titles. +</p> </div> @@ -147,8 +148,9 @@ chart titles.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the series title.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the series title. +</p> </div></span> </li> @@ -188,8 +190,9 @@ chart titles.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the series title</p> + <p> +Serializes the series title +</p> </div> @@ -208,8 +211,9 @@ chart titles.</p> — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -253,19 +257,20 @@ chart titles.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/series_title.rb', line 8</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:tx</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:strRef</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:f</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='id cell_range'>cell_range</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='ivar'>@cell</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:strCache</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:ptCount</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='int'>1</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:pt</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:idx</span><span class='op'>=></span><span class='int'>0</span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:v</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='ivar'>@text</span><span class='rparen'>)</span> - <span class='rbrace'>}</span> - <span class='rbrace'>}</span> - <span class='rbrace'>}</span> - <span class='rbrace'>}</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:tx'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:strRef'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:f'</span><span class='comma token'>,</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='cell_range identifier id'>cell_range</span><span class='lparen token'>(</span><span class='lbrack token'>[</span><span class='@cell ivar id'>@cell</span><span class='rbrack token'>]</span><span class='rparen token'>)</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:strCache'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:ptCount'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='integer val'>1</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:pt'</span><span class='comma token'>,</span> <span class='symbol val'>:idx=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:v'</span><span class='comma token'>,</span> <span class='@text ivar id'>@text</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -276,9 +281,9 @@ chart titles.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:38 2011 by + Generated on Sun Nov 27 18:05:01 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/Styles.html b/doc/Axlsx/Styles.html index f0eff10d..daac86c5 100644 --- a/doc/Axlsx/Styles.html +++ b/doc/Axlsx/Styles.html @@ -97,18 +97,20 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage styles is with add_style</p> + <div class='inline'><p> +The recommended way to manage styles is with add_style +</p> </div> </div> - -<p>The Styles class manages worksheet styles In addition to creating the +<p> +The Styles class manages worksheet styles In addition to creating the require style objects for a valid xlsx package, this class provides the key mechanism for adding styles to your workbook, and safely applying them to the cells of your worksheet. All portions of the stylesheet are implemented here exception colors, which specify legacy and modified pallete colors, -and exLst, whic is used as a future feature data storage area.</p> +and exLst, whic is used as a future feature data storage area. +</p> </div> @@ -149,9 +151,10 @@ and exLst, whic is used as a future feature data storage area.</p> - <span class="summary_desc"><div class='inline'> -<p>The collection of borders used in this workbook Axlsx predefines -THIN_BORDER which can be used to put a border around all of your cells.</p> + <span class="summary_desc"><div class='inline'><p> +The collection of borders used in this workbook Axlsx predefines +THIN_BORDER which can be used to put a border around all of your cells. +</p> </div></span> </li> @@ -176,9 +179,10 @@ THIN_BORDER which can be used to put a border around all of your cells.</p> - <span class="summary_desc"><div class='inline'> -<p>The collection of named styles, referencing cellStyleXfs items in the -workbook.</p> + <span class="summary_desc"><div class='inline'><p> +The collection of named styles, referencing cellStyleXfs items in the +workbook. +</p> </div></span> </li> @@ -203,9 +207,10 @@ workbook.</p> - <span class="summary_desc"><div class='inline'> -<p>The collection of master formatting records for named cell styles, which -means records defined in cellStyles, in the workbook.</p> + <span class="summary_desc"><div class='inline'><p> +The collection of master formatting records for named cell styles, which +means records defined in cellStyles, in the workbook. +</p> </div></span> </li> @@ -230,8 +235,9 @@ means records defined in cellStyles, in the workbook.</p> - <span class="summary_desc"><div class='inline'> -<p>The collection of master formatting records.</p> + <span class="summary_desc"><div class='inline'><p> +The collection of master formatting records. +</p> </div></span> </li> @@ -256,8 +262,9 @@ means records defined in cellStyles, in the workbook.</p> - <span class="summary_desc"><div class='inline'> -<p>The collection of non-cell formatting records used in the worksheet.</p> + <span class="summary_desc"><div class='inline'><p> +The collection of non-cell formatting records used in the worksheet. +</p> </div></span> </li> @@ -282,8 +289,9 @@ means records defined in cellStyles, in the workbook.</p> - <span class="summary_desc"><div class='inline'> -<p>The collection of fills used in this workbook.</p> + <span class="summary_desc"><div class='inline'><p> +The collection of fills used in this workbook. +</p> </div></span> </li> @@ -308,8 +316,9 @@ means records defined in cellStyles, in the workbook.</p> - <span class="summary_desc"><div class='inline'> -<p>The collection of fonts used in this workbook.</p> + <span class="summary_desc"><div class='inline'><p> +The collection of fonts used in this workbook. +</p> </div></span> </li> @@ -334,8 +343,9 @@ means records defined in cellStyles, in the workbook.</p> - <span class="summary_desc"><div class='inline'> -<p>numFmts for your styles.</p> + <span class="summary_desc"><div class='inline'><p> +numFmts for your styles. +</p> </div></span> </li> @@ -360,9 +370,10 @@ means records defined in cellStyles, in the workbook.</p> - <span class="summary_desc"><div class='inline'> -<p>The collection of table styles that will be available to the user in the -excel UI.</p> + <span class="summary_desc"><div class='inline'><p> +The collection of table styles that will be available to the user in the +excel UI. +</p> </div></span> </li> @@ -397,8 +408,9 @@ excel UI.</p> - <span class="summary_desc"><div class='inline'> -<p>Drastically simplifies style creation and management.</p> + <span class="summary_desc"><div class='inline'><p> +Drastically simplifies style creation and management. +</p> </div></span> </li> @@ -422,9 +434,10 @@ excel UI.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a new Styles object and prepopulates it with the requires objects -to generate a valid package style part.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new Styles object and prepopulates it with the requires objects +to generate a valid package style part. +</p> </div></span> </li> @@ -446,8 +459,9 @@ to generate a valid package style part.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the styles document.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the styles document. +</p> </div></span> </li> @@ -468,9 +482,10 @@ to generate a valid package style part.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new Styles object and prepopulates it with the requires objects -to generate a valid package style part.</p> + <p> +Creates a new Styles object and prepopulates it with the requires objects +to generate a valid package style part. +</p> </div> @@ -491,9 +506,10 @@ to generate a valid package style part.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 118</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='rparen'>)</span> - <span class='id load_default_styles'>load_default_styles</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rparen token'>)</span> + <span class='load_default_styles identifier id'>load_default_styles</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -519,14 +535,16 @@ to generate a valid package style part.</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage styles is with add_style</p> + <div class='inline'><p> +The recommended way to manage styles is with add_style +</p> </div> </div> - -<p>The collection of borders used in this workbook Axlsx predefines -THIN_BORDER which can be used to put a border around all of your cells.</p> +<p> +The collection of borders used in this workbook Axlsx predefines +THIN_BORDER which can be used to put a border around all of your cells. +</p> </div> @@ -567,9 +585,10 @@ THIN_BORDER which can be used to put a border around all of your cells.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 85</span> -<span class='kw'>def</span> <span class='id borders'>borders</span> - <span class='ivar'>@borders</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='borders identifier id'>borders</span> + <span class='@borders ivar id'>@borders</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -590,14 +609,16 @@ THIN_BORDER which can be used to put a border around all of your cells.</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage styles is with add_style</p> + <div class='inline'><p> +The recommended way to manage styles is with add_style +</p> </div> </div> - -<p>The collection of named styles, referencing cellStyleXfs items in the -workbook.</p> +<p> +The collection of named styles, referencing cellStyleXfs items in the +workbook. +</p> </div> @@ -638,9 +659,10 @@ workbook.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 97</span> -<span class='kw'>def</span> <span class='id cellStyles'>cellStyles</span> - <span class='ivar'>@cellStyles</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='cellStyles identifier id'>cellStyles</span> + <span class='@cellStyles ivar id'>@cellStyles</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -661,14 +683,16 @@ workbook.</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage styles is with add_style</p> + <div class='inline'><p> +The recommended way to manage styles is with add_style +</p> </div> </div> - -<p>The collection of master formatting records for named cell styles, which -means records defined in cellStyles, in the workbook</p> +<p> +The collection of master formatting records for named cell styles, which +means records defined in cellStyles, in the workbook +</p> </div> @@ -709,9 +733,10 @@ means records defined in cellStyles, in the workbook</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 91</span> -<span class='kw'>def</span> <span class='id cellStyleXfs'>cellStyleXfs</span> - <span class='ivar'>@cellStyleXfs</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='cellStyleXfs identifier id'>cellStyleXfs</span> + <span class='@cellStyleXfs ivar id'>@cellStyleXfs</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -732,14 +757,16 @@ means records defined in cellStyles, in the workbook</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage styles is with add_style</p> + <div class='inline'><p> +The recommended way to manage styles is with add_style +</p> </div> </div> - -<p>The collection of master formatting records. This is the list that you will -actually use in styling a workbook.</p> +<p> +The collection of master formatting records. This is the list that you will +actually use in styling a workbook. +</p> </div> @@ -780,9 +807,10 @@ actually use in styling a workbook.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 103</span> -<span class='kw'>def</span> <span class='id cellXfs'>cellXfs</span> - <span class='ivar'>@cellXfs</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='cellXfs identifier id'>cellXfs</span> + <span class='@cellXfs ivar id'>@cellXfs</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -803,13 +831,15 @@ actually use in styling a workbook.</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage styles is with add_style</p> + <div class='inline'><p> +The recommended way to manage styles is with add_style +</p> </div> </div> - -<p>The collection of non-cell formatting records used in the worksheet.</p> +<p> +The collection of non-cell formatting records used in the worksheet. +</p> </div> @@ -850,9 +880,10 @@ actually use in styling a workbook.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 109</span> -<span class='kw'>def</span> <span class='id dxfs'>dxfs</span> - <span class='ivar'>@dxfs</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='dxfs identifier id'>dxfs</span> + <span class='@dxfs ivar id'>@dxfs</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -873,13 +904,15 @@ actually use in styling a workbook.</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage styles is with add_style</p> + <div class='inline'><p> +The recommended way to manage styles is with add_style +</p> </div> </div> - -<p>The collection of fills used in this workbook</p> +<p> +The collection of fills used in this workbook +</p> </div> @@ -920,9 +953,10 @@ actually use in styling a workbook.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 78</span> -<span class='kw'>def</span> <span class='id fills'>fills</span> - <span class='ivar'>@fills</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='fills identifier id'>fills</span> + <span class='@fills ivar id'>@fills</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -943,13 +977,15 @@ actually use in styling a workbook.</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage styles is with add_style</p> + <div class='inline'><p> +The recommended way to manage styles is with add_style +</p> </div> </div> - -<p>The collection of fonts used in this workbook</p> +<p> +The collection of fonts used in this workbook +</p> </div> @@ -990,9 +1026,10 @@ actually use in styling a workbook.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 72</span> -<span class='kw'>def</span> <span class='id fonts'>fonts</span> - <span class='ivar'>@fonts</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='fonts identifier id'>fonts</span> + <span class='@fonts ivar id'>@fonts</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1013,48 +1050,51 @@ actually use in styling a workbook.</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage styles is with add_style</p> + <div class='inline'><p> +The recommended way to manage styles is with add_style +</p> </div> </div> - -<p>numFmts for your styles.</p> - -<pre class="code">The default styles, which change based on the system local, are as follows. -id formatCode - 0 General - 1 0 - 2 0.00 - 3 #,##0 - 4 #,##0.00 - 9 0% - 10 0.00% - 11 0.00E+00 - 12 # ?/? - 13 # ??/?? - 14 mm-dd-yy - 15 d-mmm-yy - 16 d-mmm - 17 mmm-yy - 18 h:mm AM/PM - 19 h:mm:ss AM/PM - 20 h:mm - 21 h:mm:ss - 22 m/d/yy h:mm - 37 #,##0 ;(#,##0) - 38 #,##0 ;[Red](#,##0) - 39 #,##0.00;(#,##0.00) - 40 #,##0.00;[Red](#,##0.00) - 45 mm:ss - 46 [h]:mm:ss - 47 mmss.0 - 48 ##0.0E+0 - 49 @ -Axlsx also defines the following constants which you can use in add_style. - NUM_FMT_PERCENT formats to "0%" - NUM_FMT_YYYYMMDD formats to "yyyy/mm/dd" - NUM_FMT_YYYYMMDDHHMMSS formats to "yyyy/mm/dd hh:mm:ss"</pre> +<p> +numFmts for your styles. +</p> +<pre class="code"> + <span class='The constant id'>The</span> <span class='default identifier id'>default</span> <span class='styles identifier id'>styles</span><span class='comma token'>,</span> <span class='which identifier id'>which</span> <span class='change identifier id'>change</span> <span class='based identifier id'>based</span> <span class='on identifier id'>on</span> <span class='the identifier id'>the</span> <span class='system identifier id'>system</span> <span class='local identifier id'>local</span><span class='comma token'>,</span> <span class='are identifier id'>are</span> <span class='as identifier id'>as</span> <span class='follows identifier id'>follows</span><span class='dot token'>.</span> + <span class='id identifier id'>id</span> <span class='formatCode identifier id'>formatCode</span> + <span class='integer val'>0</span> <span class='General constant id'>General</span> + <span class='integer val'>1</span> <span class='integer val'>0</span> + <span class='integer val'>2</span> <span class='integer val'>0</span><span class='integer val'>.00</span> + <span class='integer val'>3</span> <span class='comment val'>#,##0</span> + <span class='integer val'>4</span> <span class='comment val'>#,##0.00</span> + <span class='integer val'>9</span> <span class='integer val'>0</span><span class='mod op'>%</span> + <span class='integer val'>10</span> <span class='integer val'>0</span><span class='integer val'>.00</span><span class='mod op'>%</span> + <span class='integer val'>11</span> <span class='integer val'>0</span><span class='float val'>.00E+00</span> + <span class='integer val'>12</span> <span class='comment val'># ?/?</span> + <span class='integer val'>13</span> <span class='comment val'># ??/??</span> + <span class='integer val'>14</span> <span class='mm identifier id'>mm</span><span class='minus op'>-</span><span class='dd identifier id'>dd</span><span class='minus op'>-</span><span class='yy identifier id'>yy</span> + <span class='integer val'>15</span> <span class='d identifier id'>d</span><span class='minus op'>-</span><span class='mmm identifier id'>mmm</span><span class='minus op'>-</span><span class='yy identifier id'>yy</span> + <span class='integer val'>16</span> <span class='d identifier id'>d</span><span class='minus op'>-</span><span class='mmm identifier id'>mmm</span> + <span class='integer val'>17</span> <span class='mmm identifier id'>mmm</span><span class='minus op'>-</span><span class='yy identifier id'>yy</span> + <span class='integer val'>18</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span> <span class='AM constant id'>AM</span><span class='div op'>/</span><span class='PM constant id'>PM</span> + <span class='integer val'>19</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span><span class='symbol val'>:ss</span> <span class='AM constant id'>AM</span><span class='div op'>/</span><span class='PM constant id'>PM</span> + <span class='integer val'>20</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span> + <span class='integer val'>21</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span><span class='symbol val'>:ss</span> + <span class='integer val'>22</span> <span class='m identifier id'>m</span><span class='div op'>/</span><span class='d identifier id'>d</span><span class='div op'>/</span><span class='yy identifier id'>yy</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span> + <span class='integer val'>37</span> <span class='comment val'>#,##0 ;(#,##0)</span> + <span class='integer val'>38</span> <span class='comment val'>#,##0 ;[Red](#,##0)</span> + <span class='integer val'>39</span> <span class='comment val'>#,##0.00;(#,##0.00)</span> + <span class='integer val'>40</span> <span class='comment val'>#,##0.00;[Red](#,##0.00)</span> + <span class='integer val'>45</span> <span class='mm identifier id'>mm</span><span class='symbol val'>:ss</span> + <span class='integer val'>46</span> <span class='lbrack token'>[</span><span class='h identifier id'>h</span><span class='rbrack token'>]</span><span class='symbol val'>:mm</span><span class='symbol val'>:ss</span> + <span class='integer val'>47</span> <span class='mmss identifier id'>mmss</span><span class='integer val'>.0</span> + <span class='integer val'>48</span> <span class='comment val'>##0.0E+0</span> + <span class='integer val'>49</span> @ + <span class='Axlsx constant id'>Axlsx</span> <span class='also identifier id'>also</span> <span class='defines identifier id'>defines</span> <span class='the identifier id'>the</span> <span class='following identifier id'>following</span> <span class='constants identifier id'>constants</span> <span class='which identifier id'>which</span> <span class='you identifier id'>you</span> <span class='can identifier id'>can</span> <span class='use identifier id'>use</span> <span class='in in kw'>in</span> <span class='add_style identifier id'>add_style</span><span class='dot token'>.</span> + <span class='NUM_FMT_PERCENT constant id'>NUM_FMT_PERCENT</span> <span class='formats identifier id'>formats</span> <span class='to identifier id'>to</span> <span class='string val'>"0%"</span> + <span class='NUM_FMT_YYYYMMDD constant id'>NUM_FMT_YYYYMMDD</span> <span class='formats identifier id'>formats</span> <span class='to identifier id'>to</span> <span class='string val'>"yyyy/mm/dd"</span> + <span class='NUM_FMT_YYYYMMDDHHMMSS constant id'>NUM_FMT_YYYYMMDDHHMMSS</span> <span class='formats identifier id'>formats</span> <span class='to identifier id'>to</span> <span class='string val'>"yyyy/mm/dd hh:mm:ss"</span> +</pre> </div> @@ -1097,9 +1137,10 @@ Axlsx also defines the following constants which you can use in add_style. <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 66</span> -<span class='kw'>def</span> <span class='id numFmts'>numFmts</span> - <span class='ivar'>@numFmts</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='numFmts identifier id'>numFmts</span> + <span class='@numFmts ivar id'>@numFmts</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1120,14 +1161,16 @@ Axlsx also defines the following constants which you can use in add_style. <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage styles is with add_style</p> + <div class='inline'><p> +The recommended way to manage styles is with add_style +</p> </div> </div> - -<p>The collection of table styles that will be available to the user in the -excel UI</p> +<p> +The collection of table styles that will be available to the user in the +excel UI +</p> </div> @@ -1168,9 +1211,10 @@ excel UI</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 115</span> -<span class='kw'>def</span> <span class='id tableStyles'>tableStyles</span> - <span class='ivar'>@tableStyles</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='tableStyles identifier id'>tableStyles</span> + <span class='@tableStyles ivar id'>@tableStyles</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1192,8 +1236,9 @@ excel UI</p> </p><div class="docstring"> <div class="discussion"> - -<p>Drastically simplifies style creation and management.</p> + <p> +Drastically simplifies style creation and management. +</p> </div> @@ -1203,59 +1248,63 @@ excel UI</p> <div class="examples"> <h3>Examples:</h3> - <h4><div class='inline'> -<p>You Got Style</p> + <h4><div class='inline'><p> +You Got Style +</p> </div></h4> - <pre class="example code">require "rubygems" # if that is your preferred way to manage gems! -require "axlsx" + <pre class="example code"><span class='require identifier id'>require</span> <span class='string val'>"rubygems"</span> <span class='comment val'># if that is your preferred way to manage gems!</span> +<span class='require identifier id'>require</span> <span class='string val'>"axlsx"</span> -p = Axlsx::Package.new -ws = p.workbook.add_worksheet +<span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> +<span class='ws identifier id'>ws</span> <span class='assign token'>=</span> <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> -# black text on a white background at 14pt with thin borders! -title = ws.style.add_style(:bg_color => "FFFF0000", :fg_color=>"#FF000000", :sz=>14, :border=>Axlsx::STYLE_THIN_BORDER +<span class='comment val'># black text on a white background at 14pt with thin borders!</span> +<span class='title identifier id'>title</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='style identifier id'>style</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span><span class='lparen token'>(</span><span class='symbol val'>:bg_color</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"FFFF0000"</span><span class='comma token'>,</span> <span class='symbol val'>:fg_color=</span><span class='gt op'>></span><span class='string val'>"#FF000000"</span><span class='comma token'>,</span> <span class='symbol val'>:sz=</span><span class='gt op'>></span><span class='integer val'>14</span><span class='comma token'>,</span> <span class='symbol val'>:border=</span><span class='gt op'>></span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span> -ws.add_row :values => ["Least Popular Pets"] -ws.add_row :values => ["", "Dry Skinned Reptiles", "Bald Cats", "Violent Parrots"], :style=>title -ws.add_row :values => ["Votes", 6, 4, 1], :style=>Axlsx::STYLE_THIN_BORDER -f = File.open('example_you_got_style.xlsx', 'w') -p.serialize(f)</pre> +<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Least Popular Pets"</span><span class='rbrack token'>]</span> +<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>""</span><span class='comma token'>,</span> <span class='string val'>"Dry Skinned Reptiles"</span><span class='comma token'>,</span> <span class='string val'>"Bald Cats"</span><span class='comma token'>,</span> <span class='string val'>"Violent Parrots"</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='title identifier id'>title</span> +<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Votes"</span><span class='comma token'>,</span> <span class='integer val'>6</span><span class='comma token'>,</span> <span class='integer val'>4</span><span class='comma token'>,</span> <span class='integer val'>1</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span> +<span class='f identifier id'>f</span> <span class='assign token'>=</span> <span class='File constant id'>File</span><span class='dot token'>.</span><span class='open identifier id'>open</span><span class='lparen token'>(</span><span class='string val'>'example_you_got_style.xlsx'</span><span class='comma token'>,</span> <span class='string val'>'w'</span><span class='rparen token'>)</span> +<span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='f identifier id'>f</span><span class='rparen token'>)</span> +</pre> - <h4><div class='inline'> -<p>Styling specifically</p> + <h4><div class='inline'><p> +Styling specifically +</p> </div></h4> - <pre class="example code"><span class='comment'># an example of applying specific styles to specific cells -</span><span class='id require'>require</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>rubygems</span><span class='tstring_end'>"</span></span> <span class='comment'># if that is your preferred way to manage gems! -</span><span class='id require'>require</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>axlsx</span><span class='tstring_end'>"</span></span> - -<span class='id p'>p</span> <span class='op'>=</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span> -<span class='id ws'>ws</span> <span class='op'>=</span> <span class='id p'>p</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id add_worksheet'>add_worksheet</span> - -<span class='comment'># define your styles -</span><span class='id title'>title</span> <span class='op'>=</span> <span class='id ws'>ws</span><span class='period'>.</span><span class='id style'>style</span><span class='period'>.</span><span class='id add_style'>add_style</span><span class='lparen'>(</span><span class='symbol'>:bg_color</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>FFFF0000</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> - <span class='symbol'>:fg_color</span><span class='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>#FF000000</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> - <span class='symbol'>:border</span><span class='op'>=></span><span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>STYLE_THIN_BORDER</span><span class='comma'>,</span> - <span class='symbol'>:alignment</span><span class='op'>=></span><span class='lbrace'>{</span><span class='symbol'>:horizontal</span> <span class='op'>=></span> <span class='symbol'>:center</span><span class='rbrace'>}</span><span class='rparen'>)</span> - -<span class='id date_time'>date_time</span> <span class='op'>=</span> <span class='id ws'>ws</span><span class='period'>.</span><span class='id style'>style</span><span class='period'>.</span><span class='id add_style'>add_style</span><span class='lparen'>(</span><span class='symbol'>:num_fmt</span> <span class='op'>=></span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>NUM_FMT_YYYYMMDDHHMMSS</span><span class='comma'>,</span> - <span class='symbol'>:border</span><span class='op'>=></span><span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>STYLE_THIN_BORDER</span><span class='rparen'>)</span> - -<span class='id percent'>percent</span> <span class='op'>=</span> <span class='id ws'>ws</span><span class='period'>.</span><span class='id style'>style</span><span class='period'>.</span><span class='id add_style'>add_style</span><span class='lparen'>(</span><span class='symbol'>:num_fmt</span> <span class='op'>=></span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>NUM_FMT_PERCENT</span><span class='comma'>,</span> - <span class='symbol'>:border</span><span class='op'>=></span><span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>STYLE_THIN_BORDER</span><span class='rparen'>)</span> - -<span class='id currency'>currency</span> <span class='op'>=</span> <span class='id ws'>ws</span><span class='period'>.</span><span class='id style'>style</span><span class='period'>.</span><span class='id add_style'>add_style</span><span class='lparen'>(</span><span class='symbol'>:format_code</span><span class='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>¥#,##0;[Red]¥-#,##0</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> - <span class='symbol'>:border</span><span class='op'>=></span><span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>STYLE_THIN_BORDER</span><span class='rparen'>)</span> - -<span class='comment'># build your rows -</span><span class='id ws'>ws</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='symbol'>:values</span> <span class='op'>=></span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Genreated At:</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='const'>Time</span><span class='period'>.</span><span class='id now'>now</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:styles</span><span class='op'>=></span><span class='lbracket'>[</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id date_time'>date_time</span><span class='rbracket'>]</span> -<span class='id ws'>ws</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='symbol'>:values</span> <span class='op'>=></span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Previous Year Quarterly Profits (JPY)</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:style</span><span class='op'>=></span><span class='id title'>title</span> -<span class='id ws'>ws</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='symbol'>:values</span> <span class='op'>=></span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Quarter</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Profit</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>% of Total</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:style</span><span class='op'>=></span><span class='id title'>title</span> -<span class='id ws'>ws</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='symbol'>:values</span> <span class='op'>=></span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Q1</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='int'>4000</span><span class='comma'>,</span> <span class='int'>40</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:style</span><span class='op'>=></span><span class='lbracket'>[</span><span class='id title'>title</span><span class='comma'>,</span> <span class='id currency'>currency</span><span class='comma'>,</span> <span class='id percent'>percent</span><span class='rbracket'>]</span> -<span class='id ws'>ws</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='symbol'>:values</span> <span class='op'>=></span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Q2</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='int'>3000</span><span class='comma'>,</span> <span class='int'>30</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:style</span><span class='op'>=></span><span class='lbracket'>[</span><span class='id title'>title</span><span class='comma'>,</span> <span class='id currency'>currency</span><span class='comma'>,</span> <span class='id percent'>percent</span><span class='rbracket'>]</span> -<span class='id ws'>ws</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='symbol'>:values</span> <span class='op'>=></span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Q3</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='int'>1000</span><span class='comma'>,</span> <span class='int'>10</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:style</span><span class='op'>=></span><span class='lbracket'>[</span><span class='id title'>title</span><span class='comma'>,</span> <span class='id currency'>currency</span><span class='comma'>,</span> <span class='id percent'>percent</span><span class='rbracket'>]</span> -<span class='id ws'>ws</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='symbol'>:values</span> <span class='op'>=></span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Q4</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='int'>2000</span><span class='comma'>,</span> <span class='int'>20</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:style</span><span class='op'>=></span><span class='lbracket'>[</span><span class='id title'>title</span><span class='comma'>,</span> <span class='id currency'>currency</span><span class='comma'>,</span> <span class='id percent'>percent</span><span class='rbracket'>]</span> -<span class='id f'>f</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id open'>open</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>example_you_got_style.xlsx</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>w</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> -<span class='id p'>p</span><span class='period'>.</span><span class='id serialize'>serialize</span><span class='lparen'>(</span><span class='id f'>f</span><span class='rparen'>)</span></pre> + <pre class="example code"><span class='comment val'># an example of applying specific styles to specific cells</span> +<span class='require identifier id'>require</span> <span class='string val'>"rubygems"</span> <span class='comment val'># if that is your preferred way to manage gems!</span> +<span class='require identifier id'>require</span> <span class='string val'>"axlsx"</span> + +<span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> +<span class='ws identifier id'>ws</span> <span class='assign token'>=</span> <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> + +<span class='comment val'># define your styles</span> +<span class='title identifier id'>title</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='style identifier id'>style</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span><span class='lparen token'>(</span><span class='symbol val'>:bg_color</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"FFFF0000"</span><span class='comma token'>,</span> + <span class='symbol val'>:fg_color=</span><span class='gt op'>></span><span class='string val'>"#FF000000"</span><span class='comma token'>,</span> + <span class='symbol val'>:border=</span><span class='gt op'>></span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span><span class='comma token'>,</span> + <span class='symbol val'>:alignment=</span><span class='gt op'>></span><span class='lbrace token'>{</span><span class='symbol val'>:horizontal</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='symbol val'>:center</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + +<span class='date_time identifier id'>date_time</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='style identifier id'>style</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span><span class='lparen token'>(</span><span class='symbol val'>:num_fmt</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='NUM_FMT_YYYYMMDDHHMMSS constant id'>NUM_FMT_YYYYMMDDHHMMSS</span><span class='comma token'>,</span> + <span class='symbol val'>:border=</span><span class='gt op'>></span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span><span class='rparen token'>)</span> + +<span class='percent identifier id'>percent</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='style identifier id'>style</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span><span class='lparen token'>(</span><span class='symbol val'>:num_fmt</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='NUM_FMT_PERCENT constant id'>NUM_FMT_PERCENT</span><span class='comma token'>,</span> + <span class='symbol val'>:border=</span><span class='gt op'>></span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span><span class='rparen token'>)</span> + +<span class='currency identifier id'>currency</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='style identifier id'>style</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span><span class='lparen token'>(</span><span class='symbol val'>:format_code=</span><span class='gt op'>></span><span class='string val'>"¥#,##0;[Red]¥-#,##0"</span><span class='comma token'>,</span> + <span class='symbol val'>:border=</span><span class='gt op'>></span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span><span class='rparen token'>)</span> + +<span class='comment val'># build your rows</span> +<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Genreated At:"</span><span class='comma token'>,</span> <span class='Time constant id'>Time</span><span class='dot token'>.</span><span class='now identifier id'>now</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:styles=</span><span class='gt op'>></span><span class='lbrack token'>[</span><span class='nil nil kw'>nil</span><span class='comma token'>,</span> <span class='date_time identifier id'>date_time</span><span class='rbrack token'>]</span> +<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Previous Year Quarterly Profits (JPY)"</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='title identifier id'>title</span> +<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Quarter"</span><span class='comma token'>,</span> <span class='string val'>"Profit"</span><span class='comma token'>,</span> <span class='string val'>"% of Total"</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='title identifier id'>title</span> +<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Q1"</span><span class='comma token'>,</span> <span class='integer val'>4000</span><span class='comma token'>,</span> <span class='integer val'>40</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='lbrack token'>[</span><span class='title identifier id'>title</span><span class='comma token'>,</span> <span class='currency identifier id'>currency</span><span class='comma token'>,</span> <span class='percent identifier id'>percent</span><span class='rbrack token'>]</span> +<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Q2"</span><span class='comma token'>,</span> <span class='integer val'>3000</span><span class='comma token'>,</span> <span class='integer val'>30</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='lbrack token'>[</span><span class='title identifier id'>title</span><span class='comma token'>,</span> <span class='currency identifier id'>currency</span><span class='comma token'>,</span> <span class='percent identifier id'>percent</span><span class='rbrack token'>]</span> +<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Q3"</span><span class='comma token'>,</span> <span class='integer val'>1000</span><span class='comma token'>,</span> <span class='integer val'>10</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='lbrack token'>[</span><span class='title identifier id'>title</span><span class='comma token'>,</span> <span class='currency identifier id'>currency</span><span class='comma token'>,</span> <span class='percent identifier id'>percent</span><span class='rbrack token'>]</span> +<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Q4"</span><span class='comma token'>,</span> <span class='integer val'>2000</span><span class='comma token'>,</span> <span class='integer val'>20</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='lbrack token'>[</span><span class='title identifier id'>title</span><span class='comma token'>,</span> <span class='currency identifier id'>currency</span><span class='comma token'>,</span> <span class='percent identifier id'>percent</span><span class='rbrack token'>]</span> +<span class='f identifier id'>f</span> <span class='assign token'>=</span> <span class='File constant id'>File</span><span class='dot token'>.</span><span class='open identifier id'>open</span><span class='lparen token'>(</span><span class='string val'>'example_you_got_style.xlsx'</span><span class='comma token'>,</span> <span class='string val'>'w'</span><span class='rparen token'>)</span> +<span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='f identifier id'>f</span><span class='rparen token'>)</span> +</pre> </div> <h3>Parameters:</h3> @@ -1273,8 +1322,9 @@ p.serialize(f)</pre> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -1293,8 +1343,9 @@ p.serialize(f)</pre> <span class="default"> </span> - — <div class='inline'> -<p>The text color</p> + — <div class='inline'><p> +The text color +</p> </div> </li> @@ -1304,8 +1355,9 @@ p.serialize(f)</pre> <span class="default"> </span> - — <div class='inline'> -<p>The text size</p> + — <div class='inline'><p> +The text size +</p> </div> </li> @@ -1315,8 +1367,9 @@ p.serialize(f)</pre> <span class="default"> </span> - — <div class='inline'> -<p>Indicates if the text should be bold</p> + — <div class='inline'><p> +Indicates if the text should be bold +</p> </div> </li> @@ -1326,8 +1379,9 @@ p.serialize(f)</pre> <span class="default"> </span> - — <div class='inline'> -<p>Indicates if the text should be italicised</p> + — <div class='inline'><p> +Indicates if the text should be italicised +</p> </div> </li> @@ -1337,8 +1391,9 @@ p.serialize(f)</pre> <span class="default"> </span> - — <div class='inline'> -<p>Indicates if the text should be rendered with a strikethrough</p> + — <div class='inline'><p> +Indicates if the text should be rendered with a strikethrough +</p> </div> </li> @@ -1348,8 +1403,9 @@ p.serialize(f)</pre> <span class="default"> </span> - — <div class='inline'> -<p>Indicates if the text should be rendered with a shadow</p> + — <div class='inline'><p> +Indicates if the text should be rendered with a shadow +</p> </div> </li> @@ -1359,8 +1415,9 @@ p.serialize(f)</pre> <span class="default"> </span> - — <div class='inline'> -<p>The character set to use.</p> + — <div class='inline'><p> +The character set to use. +</p> </div> </li> @@ -1370,8 +1427,9 @@ p.serialize(f)</pre> <span class="default"> </span> - — <div class='inline'> -<p>The font family to use.</p> + — <div class='inline'><p> +The font family to use. +</p> </div> </li> @@ -1381,8 +1439,9 @@ p.serialize(f)</pre> <span class="default"> </span> - — <div class='inline'> -<p>The name of the font to use</p> + — <div class='inline'><p> +The name of the font to use +</p> </div> </li> @@ -1392,8 +1451,9 @@ p.serialize(f)</pre> <span class="default"> </span> - — <div class='inline'> -<p>The number format to apply</p> + — <div class='inline'><p> +The number format to apply +</p> </div> </li> @@ -1403,8 +1463,9 @@ p.serialize(f)</pre> <span class="default"> </span> - — <div class='inline'> -<p>The formatting to apply. If this is specified, num_fmt is ignored.</p> + — <div class='inline'><p> +The formatting to apply. If this is specified, num_fmt is ignored. +</p> </div> </li> @@ -1414,8 +1475,9 @@ p.serialize(f)</pre> <span class="default"> </span> - — <div class='inline'> -<p>The border style to use.</p> + — <div class='inline'><p> +The border style to use. +</p> </div> </li> @@ -1425,8 +1487,9 @@ p.serialize(f)</pre> <span class="default"> </span> - — <div class='inline'> -<p>The background color to apply to the cell</p> + — <div class='inline'><p> +The background color to apply to the cell +</p> </div> </li> @@ -1436,8 +1499,9 @@ p.serialize(f)</pre> <span class="default"> </span> - — <div class='inline'> -<p>Indicates if the cell should be hidden</p> + — <div class='inline'><p> +Indicates if the cell should be hidden +</p> </div> </li> @@ -1447,8 +1511,9 @@ p.serialize(f)</pre> <span class="default"> </span> - — <div class='inline'> -<p>Indicates if the cell should be locked</p> + — <div class='inline'><p> +Indicates if the cell should be locked +</p> </div> </li> @@ -1458,8 +1523,9 @@ p.serialize(f)</pre> <span class="default"> </span> - — <div class='inline'> -<p>A hash defining any of the attributes used in CellAlignment</p> + — <div class='inline'><p> +A hash defining any of the attributes used in CellAlignment +</p> </div> </li> @@ -1555,51 +1621,52 @@ p.serialize(f)</pre> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 191</span> -<span class='kw'>def</span> <span class='id add_style'>add_style</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - - <span class='id numFmtId'>numFmtId</span> <span class='op'>=</span> <span class='kw'>if</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:format_code</span><span class='rbracket'>]</span> - <span class='id n'>n</span> <span class='op'>=</span> <span class='ivar'>@numFmts</span><span class='period'>.</span><span class='id map'>map</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id f'>f</span><span class='op'>|</span> <span class='id f'>f</span><span class='period'>.</span><span class='id numFmtId'>numFmtId</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id max'>max</span> <span class='op'>+</span> <span class='int'>1</span> - <span class='id numFmts'>numFmts</span> <span class='op'><<</span> <span class='const'>NumFmt</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='symbol'>:numFmtId</span> <span class='op'>=></span> <span class='id n'>n</span><span class='comma'>,</span> <span class='symbol'>:formatCode</span><span class='op'>=></span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:format_code</span><span class='rbracket'>]</span><span class='rparen'>)</span> - <span class='id n'>n</span> - <span class='kw'>else</span> - <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:num_fmt</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='int'>0</span> - <span class='kw'>end</span> - - <span class='id borderId'>borderId</span> <span class='op'>=</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:border</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='int'>0</span> - <span class='id raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Invalid borderId</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='id borderId'>borderId</span> <span class='op'><</span> <span class='id borders'>borders</span><span class='period'>.</span><span class='id size'>size</span> - - <span class='id fill'>fill</span> <span class='op'>=</span> <span class='kw'>if</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:bg_color</span><span class='rbracket'>]</span> - <span class='id color'>color</span> <span class='op'>=</span> <span class='const'>Color</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='symbol'>:rgb</span><span class='op'>=></span><span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:bg_color</span><span class='rbracket'>]</span><span class='rparen'>)</span> - <span class='id pattern'>pattern</span> <span class='op'>=</span> <span class='const'>PatternFill</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='symbol'>:patternType</span> <span class='op'>=></span><span class='symbol'>:solid</span><span class='comma'>,</span> <span class='symbol'>:fgColor</span><span class='op'>=></span><span class='id color'>color</span><span class='rparen'>)</span> - <span class='id fills'>fills</span> <span class='op'><<</span> <span class='const'>Fill</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id pattern'>pattern</span><span class='rparen'>)</span> - <span class='kw'>else</span> - <span class='int'>0</span> - <span class='kw'>end</span> - - <span class='id fontId'>fontId</span> <span class='op'>=</span> <span class='kw'>if</span> <span class='lparen'>(</span><span class='id options'>options</span><span class='period'>.</span><span class='id values_at'>values_at</span><span class='lparen'>(</span><span class='symbol'>:fg_color</span><span class='comma'>,</span> <span class='symbol'>:sz</span><span class='comma'>,</span> <span class='symbol'>:b</span><span class='comma'>,</span> <span class='symbol'>:i</span><span class='comma'>,</span> <span class='symbol'>:strike</span><span class='comma'>,</span> <span class='symbol'>:outline</span><span class='comma'>,</span> <span class='symbol'>:shadow</span><span class='comma'>,</span> <span class='symbol'>:charset</span><span class='comma'>,</span> <span class='symbol'>:family</span><span class='comma'>,</span> <span class='symbol'>:font_name</span><span class='rparen'>)</span><span class='period'>.</span><span class='id length'>length</span><span class='rparen'>)</span> - <span class='id font'>font</span> <span class='op'>=</span> <span class='const'>Font</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='rparen'>)</span> - <span class='lbracket'>[</span><span class='symbol'>:b</span><span class='comma'>,</span> <span class='symbol'>:i</span><span class='comma'>,</span> <span class='symbol'>:strike</span><span class='comma'>,</span> <span class='symbol'>:outline</span><span class='comma'>,</span> <span class='symbol'>:shadow</span><span class='comma'>,</span> <span class='symbol'>:charset</span><span class='comma'>,</span> <span class='symbol'>:family</span><span class='comma'>,</span> <span class='symbol'>:sz</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id k'>k</span><span class='op'>|</span> <span class='id font'>font</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id k'>k</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='id k'>k</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='id k'>k</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span> <span class='rbrace'>}</span> - <span class='id font'>font</span><span class='period'>.</span><span class='id color'>color</span> <span class='op'>=</span> <span class='const'>Color</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='symbol'>:rgb</span> <span class='op'>=></span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:fg_color</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:fg_color</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='id font'>font</span><span class='period'>.</span><span class='id name'>name</span> <span class='op'>=</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:font_name</span><span class='rbracket'>]</span> <span class='kw'>unless</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:font_name</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='id fonts'>fonts</span> <span class='op'><<</span> <span class='id font'>font</span> - <span class='kw'>else</span> - <span class='int'>0</span> - <span class='kw'>end</span> - - <span class='id applyProtection'>applyProtection</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:hidden</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:locked</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='int'>1</span> <span class='op'>:</span> <span class='int'>0</span> - - <span class='id xf'>xf</span> <span class='op'>=</span> <span class='const'>Xf</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='symbol'>:fillId</span> <span class='op'>=></span> <span class='id fill'>fill</span><span class='comma'>,</span> <span class='symbol'>:fontId</span><span class='op'>=></span><span class='id fontId'>fontId</span><span class='comma'>,</span> <span class='symbol'>:applyFill</span><span class='op'>=></span><span class='int'>1</span><span class='comma'>,</span> <span class='symbol'>:applyFont</span><span class='op'>=></span><span class='int'>1</span><span class='comma'>,</span> <span class='symbol'>:numFmtId</span><span class='op'>=></span><span class='id numFmtId'>numFmtId</span><span class='comma'>,</span> <span class='symbol'>:borderId</span><span class='op'>=></span><span class='id borderId'>borderId</span><span class='comma'>,</span> <span class='symbol'>:applyProtection</span><span class='op'>=></span><span class='id applyProtection'>applyProtection</span><span class='rparen'>)</span> - - <span class='kw'>if</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:alignment</span><span class='rbracket'>]</span> - <span class='id xf'>xf</span><span class='period'>.</span><span class='id alignment'>alignment</span> <span class='op'>=</span> <span class='const'>CellAlignment</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:alignment</span><span class='rbracket'>]</span><span class='rparen'>)</span> - <span class='kw'>end</span> - - <span class='kw'>if</span> <span class='id applyProtection'>applyProtection</span> - <span class='id xf'>xf</span><span class='period'>.</span><span class='id protection'>protection</span> <span class='op'>=</span> <span class='const'>CellProtection</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id options'>options</span><span class='rparen'>)</span> - <span class='kw'>end</span> - - <span class='id cellXfs'>cellXfs</span> <span class='op'><<</span> <span class='id xf'>xf</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='add_style identifier id'>add_style</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + + <span class='numFmtId identifier id'>numFmtId</span> <span class='assign token'>=</span> <span class='if if kw'>if</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:format_code</span><span class='rbrack token'>]</span> + <span class='n identifier id'>n</span> <span class='assign token'>=</span> <span class='@numFmts ivar id'>@numFmts</span><span class='dot token'>.</span><span class='map identifier id'>map</span><span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='f identifier id'>f</span><span class='bitor op'>|</span> <span class='f identifier id'>f</span><span class='dot token'>.</span><span class='numFmtId identifier id'>numFmtId</span> <span class='rbrace token'>}</span><span class='dot token'>.</span><span class='max identifier id'>max</span> <span class='plus op'>+</span> <span class='integer val'>1</span> + <span class='numFmts identifier id'>numFmts</span> <span class='lshft op'><<</span> <span class='NumFmt constant id'>NumFmt</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:numFmtId</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='n identifier id'>n</span><span class='comma token'>,</span> <span class='symbol val'>:formatCode=</span><span class='gt op'>></span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:format_code</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> + <span class='n identifier id'>n</span> + <span class='else else kw'>else</span> + <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:num_fmt</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='integer val'>0</span> + <span class='end end kw'>end</span> + + <span class='borderId identifier id'>borderId</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:border</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='integer val'>0</span> + <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='string val'>"Invalid borderId"</span> <span class='unless unless_mod kw'>unless</span> <span class='borderId identifier id'>borderId</span> <span class='lt op'><</span> <span class='borders identifier id'>borders</span><span class='dot token'>.</span><span class='size identifier id'>size</span> + + <span class='fill identifier id'>fill</span> <span class='assign token'>=</span> <span class='if if kw'>if</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:bg_color</span><span class='rbrack token'>]</span> + <span class='color identifier id'>color</span> <span class='assign token'>=</span> <span class='Color constant id'>Color</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:rgb=</span><span class='gt op'>></span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:bg_color</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> + <span class='pattern identifier id'>pattern</span> <span class='assign token'>=</span> <span class='PatternFill constant id'>PatternFill</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:patternType</span> <span class='assign token'>=</span><span class='gt op'>></span><span class='symbol val'>:solid</span><span class='comma token'>,</span> <span class='symbol val'>:fgColor=</span><span class='gt op'>></span><span class='color identifier id'>color</span><span class='rparen token'>)</span> + <span class='fills identifier id'>fills</span> <span class='lshft op'><<</span> <span class='Fill constant id'>Fill</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='pattern identifier id'>pattern</span><span class='rparen token'>)</span> + <span class='else else kw'>else</span> + <span class='integer val'>0</span> + <span class='end end kw'>end</span> + + <span class='fontId identifier id'>fontId</span> <span class='assign token'>=</span> <span class='if if kw'>if</span> <span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='dot token'>.</span><span class='values_at identifier id'>values_at</span><span class='lparen token'>(</span><span class='symbol val'>:fg_color</span><span class='comma token'>,</span> <span class='symbol val'>:sz</span><span class='comma token'>,</span> <span class='symbol val'>:b</span><span class='comma token'>,</span> <span class='symbol val'>:i</span><span class='comma token'>,</span> <span class='symbol val'>:strike</span><span class='comma token'>,</span> <span class='symbol val'>:outline</span><span class='comma token'>,</span> <span class='symbol val'>:shadow</span><span class='comma token'>,</span> <span class='symbol val'>:charset</span><span class='comma token'>,</span> <span class='symbol val'>:family</span><span class='comma token'>,</span> <span class='symbol val'>:font_name</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='length identifier id'>length</span><span class='rparen token'>)</span> + <span class='font identifier id'>font</span> <span class='assign token'>=</span> <span class='Font constant id'>Font</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='rparen token'>)</span> + <span class='lbrack token'>[</span><span class='symbol val'>:b</span><span class='comma token'>,</span> <span class='symbol val'>:i</span><span class='comma token'>,</span> <span class='symbol val'>:strike</span><span class='comma token'>,</span> <span class='symbol val'>:outline</span><span class='comma token'>,</span> <span class='symbol val'>:shadow</span><span class='comma token'>,</span> <span class='symbol val'>:charset</span><span class='comma token'>,</span> <span class='symbol val'>:family</span><span class='comma token'>,</span> <span class='symbol val'>:sz</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='k identifier id'>k</span><span class='bitor op'>|</span> <span class='font identifier id'>font</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{k}="</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='k identifier id'>k</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='k identifier id'>k</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> <span class='rbrace token'>}</span> + <span class='font identifier id'>font</span><span class='dot token'>.</span><span class='color identifier id'>color</span> <span class='assign token'>=</span> <span class='Color constant id'>Color</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:rgb</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:fg_color</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:fg_color</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='font identifier id'>font</span><span class='dot token'>.</span><span class='name identifier id'>name</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:font_name</span><span class='rbrack token'>]</span> <span class='unless unless_mod kw'>unless</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:font_name</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='fonts identifier id'>fonts</span> <span class='lshft op'><<</span> <span class='font identifier id'>font</span> + <span class='else else kw'>else</span> + <span class='integer val'>0</span> + <span class='end end kw'>end</span> + + <span class='applyProtection identifier id'>applyProtection</span> <span class='assign token'>=</span> <span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:hidden</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:locked</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='integer val'>1</span> <span class='colon op'>:</span> <span class='integer val'>0</span> + + <span class='xf identifier id'>xf</span> <span class='assign token'>=</span> <span class='Xf constant id'>Xf</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:fillId</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='fill identifier id'>fill</span><span class='comma token'>,</span> <span class='symbol val'>:fontId=</span><span class='gt op'>></span><span class='fontId identifier id'>fontId</span><span class='comma token'>,</span> <span class='symbol val'>:applyFill=</span><span class='gt op'>></span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='symbol val'>:applyFont=</span><span class='gt op'>></span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='symbol val'>:numFmtId=</span><span class='gt op'>></span><span class='numFmtId identifier id'>numFmtId</span><span class='comma token'>,</span> <span class='symbol val'>:borderId=</span><span class='gt op'>></span><span class='borderId identifier id'>borderId</span><span class='comma token'>,</span> <span class='symbol val'>:applyProtection=</span><span class='gt op'>></span><span class='applyProtection identifier id'>applyProtection</span><span class='rparen token'>)</span> + + <span class='if if kw'>if</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:alignment</span><span class='rbrack token'>]</span> + <span class='xf identifier id'>xf</span><span class='dot token'>.</span><span class='alignment identifier id'>alignment</span> <span class='assign token'>=</span> <span class='CellAlignment constant id'>CellAlignment</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:alignment</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> + + <span class='if if kw'>if</span> <span class='applyProtection identifier id'>applyProtection</span> + <span class='xf identifier id'>xf</span><span class='dot token'>.</span><span class='protection identifier id'>protection</span> <span class='assign token'>=</span> <span class='CellProtection constant id'>CellProtection</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> + + <span class='cellXfs identifier id'>cellXfs</span> <span class='lshft op'><<</span> <span class='xf identifier id'>xf</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1614,8 +1681,9 @@ p.serialize(f)</pre> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the styles document</p> + <p> +Serializes the styles document +</p> </div> @@ -1656,16 +1724,17 @@ p.serialize(f)</pre> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 239</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='rparen'>)</span> - <span class='id builder'>builder</span> <span class='op'>=</span> <span class='const'>Nokogiri</span><span class='op'>::</span><span class='const'>XML</span><span class='op'>::</span><span class='const'>Builder</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='symbol'>:encoding</span> <span class='op'>=></span> <span class='const'>ENCODING</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id xml'>xml</span><span class='op'>|</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id styleSheet'>styleSheet</span><span class='lparen'>(</span><span class='symbol'>:xmlns</span> <span class='op'>=></span> <span class='const'>XML_NS</span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='lbracket'>[</span><span class='symbol'>:numFmts</span><span class='comma'>,</span> <span class='symbol'>:fonts</span><span class='comma'>,</span> <span class='symbol'>:fills</span><span class='comma'>,</span> <span class='symbol'>:borders</span><span class='comma'>,</span> <span class='symbol'>:cellStyleXfs</span><span class='comma'>,</span> <span class='symbol'>:cellXfs</span><span class='comma'>,</span> <span class='symbol'>:cellStyles</span><span class='comma'>,</span> <span class='symbol'>:dxfs</span><span class='comma'>,</span> <span class='symbol'>:tableStyles</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id key'>key</span><span class='op'>|</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id instance_values'>instance_values</span><span class='lbracket'>[</span><span class='id key'>key</span><span class='period'>.</span><span class='id to_s'>to_s</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='kw'>end</span> - <span class='rbrace'>}</span> - <span class='kw'>end</span> - <span class='id builder'>builder</span><span class='period'>.</span><span class='id to_xml'>to_xml</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='rparen token'>)</span> + <span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='styleSheet identifier id'>styleSheet</span><span class='lparen token'>(</span><span class='symbol val'>:xmlns</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS constant id'>XML_NS</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='lbrack token'>[</span><span class='symbol val'>:numFmts</span><span class='comma token'>,</span> <span class='symbol val'>:fonts</span><span class='comma token'>,</span> <span class='symbol val'>:fills</span><span class='comma token'>,</span> <span class='symbol val'>:borders</span><span class='comma token'>,</span> <span class='symbol val'>:cellStyleXfs</span><span class='comma token'>,</span> <span class='symbol val'>:cellXfs</span><span class='comma token'>,</span> <span class='symbol val'>:cellStyles</span><span class='comma token'>,</span> <span class='symbol val'>:dxfs</span><span class='comma token'>,</span> <span class='symbol val'>:tableStyles</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='key identifier id'>key</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='lbrack token'>[</span><span class='key identifier id'>key</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1676,9 +1745,9 @@ p.serialize(f)</pre> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:38 2011 by + Generated on Sun Nov 27 18:05:03 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/TableStyle.html b/doc/Axlsx/TableStyle.html index 1f43f1e9..d4b8c80e 100644 --- a/doc/Axlsx/TableStyle.html +++ b/doc/Axlsx/TableStyle.html @@ -99,14 +99,16 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>Table are not supported in this version and only the defaults required for -a valid workbook are created.</p> + <div class='inline'><p> +Table are not supported in this version and only the defaults required for +a valid workbook are created. +</p> </div> </div> - -<p>A single table style definition and is a collection for tableStyleElements</p> +<p> +A single table style definition and is a collection for tableStyleElements +</p> </div> @@ -142,8 +144,9 @@ a valid workbook are created.</p> - <span class="summary_desc"><div class='inline'> -<p>The name of this table style.</p> + <span class="summary_desc"><div class='inline'><p> +The name of this table style. +</p> </div></span> </li> @@ -168,8 +171,9 @@ a valid workbook are created.</p> - <span class="summary_desc"><div class='inline'> -<p>indicates if this style should be applied to pivot tables.</p> + <span class="summary_desc"><div class='inline'><p> +indicates if this style should be applied to pivot tables. +</p> </div></span> </li> @@ -194,8 +198,9 @@ a valid workbook are created.</p> - <span class="summary_desc"><div class='inline'> -<p>indicates if this style should be applied to tables.</p> + <span class="summary_desc"><div class='inline'><p> +indicates if this style should be applied to tables. +</p> </div></span> </li> @@ -240,8 +245,9 @@ a valid workbook are created.</p> - <span class="summary_desc"><div class='inline'> -<p>creates a new TableStyle object.</p> + <span class="summary_desc"><div class='inline'><p> +creates a new TableStyle object. +</p> </div></span> </li> @@ -263,8 +269,9 @@ a valid workbook are created.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the table style.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the table style. +</p> </div></span> </li> @@ -290,8 +297,9 @@ a valid workbook are created.</p> </p><div class="docstring"> <div class="discussion"> - -<p>creates a new TableStyle object</p> + <p> +creates a new TableStyle object +</p> </div> @@ -323,8 +331,9 @@ a valid workbook are created.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -371,8 +380,9 @@ a valid workbook are created.</p> — - <div class='inline'> -<p>if name option is not provided.</p> + <div class='inline'><p> +if name option is not provided. +</p> </div> </li> @@ -396,13 +406,14 @@ a valid workbook are created.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style.rb', line 23</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id name'>name</span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id name'>name</span> <span class='op'>=</span> <span class='id name'>name</span> - <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> - <span class='kw'>end</span> - <span class='kw'>super</span> <span class='const'>TableStyleElement</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='name identifier id'>name</span> <span class='assign token'>=</span> <span class='name identifier id'>name</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> + <span class='super super kw'>super</span> <span class='TableStyleElement constant id'>TableStyleElement</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -435,8 +446,9 @@ a valid workbook are created.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The name of this table style</p> + <p> +The name of this table style +</p> </div> @@ -470,9 +482,10 @@ a valid workbook are created.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style.rb', line 8</span> -<span class='kw'>def</span> <span class='id name'>name</span> - <span class='ivar'>@name</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='name identifier id'>name</span> + <span class='@name ivar id'>@name</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -490,8 +503,9 @@ a valid workbook are created.</p> </p><div class="docstring"> <div class="discussion"> - -<p>indicates if this style should be applied to pivot tables</p> + <p> +indicates if this style should be applied to pivot tables +</p> </div> @@ -525,9 +539,10 @@ a valid workbook are created.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style.rb', line 12</span> -<span class='kw'>def</span> <span class='id pivot'>pivot</span> - <span class='ivar'>@pivot</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='pivot identifier id'>pivot</span> + <span class='@pivot ivar id'>@pivot</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -545,8 +560,9 @@ a valid workbook are created.</p> </p><div class="docstring"> <div class="discussion"> - -<p>indicates if this style should be applied to tables</p> + <p> +indicates if this style should be applied to tables +</p> </div> @@ -580,9 +596,10 @@ a valid workbook are created.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style.rb', line 16</span> -<span class='kw'>def</span> <span class='id table'>table</span> - <span class='ivar'>@table</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='table identifier id'>table</span> + <span class='@table ivar id'>@table</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -604,8 +621,9 @@ a valid workbook are created.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the table style</p> + <p> +Serializes the table style +</p> </div> @@ -624,8 +642,9 @@ a valid workbook are created.</p> — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -661,11 +680,12 @@ a valid workbook are created.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style.rb', line 41</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id attr'>attr</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id instance_values'>instance_values</span><span class='period'>.</span><span class='id select'>select</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id k'>k</span><span class='comma'>,</span> <span class='id v'>v</span><span class='op'>|</span> <span class='lbracket'>[</span><span class='symbol'>:name</span><span class='comma'>,</span> <span class='symbol'>:pivot</span><span class='comma'>,</span> <span class='symbol'>:table</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id include?'>include?</span> <span class='id k'>k</span> <span class='rbrace'>}</span> - <span class='id attr'>attr</span><span class='lbracket'>[</span><span class='symbol'>:count</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id size'>size</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id tableStyle'>tableStyle</span><span class='lparen'>(</span><span class='id attr'>attr</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='kw'>self</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id table_style_el'>table_style_el</span><span class='op'>|</span> <span class='id table_style_el'>table_style_el</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> <span class='rbrace'>}</span> <span class='rbrace'>}</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='attr identifier id'>attr</span> <span class='assign token'>=</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='dot token'>.</span><span class='select identifier id'>select</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='k identifier id'>k</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='bitor op'>|</span> <span class='lbrack token'>[</span><span class='symbol val'>:name</span><span class='comma token'>,</span> <span class='symbol val'>:pivot</span><span class='comma token'>,</span> <span class='symbol val'>:table</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='include? fid id'>include?</span> <span class='k identifier id'>k</span> <span class='rbrace token'>}</span> + <span class='attr identifier id'>attr</span><span class='lbrack token'>[</span><span class='symbol val'>:count</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='size identifier id'>size</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='tableStyle identifier id'>tableStyle</span><span class='lparen token'>(</span><span class='attr identifier id'>attr</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='table_style_el identifier id'>table_style_el</span><span class='bitor op'>|</span> <span class='table_style_el identifier id'>table_style_el</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -676,9 +696,9 @@ a valid workbook are created.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:39 2011 by + Generated on Sun Nov 27 18:05:20 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/TableStyleElement.html b/doc/Axlsx/TableStyleElement.html index 3f4b41fe..48dc8694 100644 --- a/doc/Axlsx/TableStyleElement.html +++ b/doc/Axlsx/TableStyleElement.html @@ -97,14 +97,16 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>tables and table styles are not supported in this version. This class -exists in preparation for that support.</p> + <div class='inline'><p> +tables and table styles are not supported in this version. This class +exists in preparation for that support. +</p> </div> </div> - -<p>an element of style that belongs to a table style.</p> +<p> +an element of style that belongs to a table style. +</p> </div> @@ -136,8 +138,9 @@ exists in preparation for that support.</p> - <span class="summary_desc"><div class='inline'> -<p>The dxfId this style element points to.</p> + <span class="summary_desc"><div class='inline'><p> +The dxfId this style element points to. +</p> </div></span> </li> @@ -162,9 +165,10 @@ exists in preparation for that support.</p> - <span class="summary_desc"><div class='inline'> -<p>Number of rows or columns used in striping when the type is firstRowStripe, -secondRowStripe, firstColumnStripe, or secondColumnStripe.</p> + <span class="summary_desc"><div class='inline'><p> +Number of rows or columns used in striping when the type is firstRowStripe, +secondRowStripe, firstColumnStripe, or secondColumnStripe. +</p> </div></span> </li> @@ -189,8 +193,9 @@ secondRowStripe, firstColumnStripe, or secondColumnStripe.</p> - <span class="summary_desc"><div class='inline'> -<p>The type of style element.</p> + <span class="summary_desc"><div class='inline'><p> +The type of style element. +</p> </div></span> </li> @@ -227,8 +232,9 @@ secondRowStripe, firstColumnStripe, or secondColumnStripe.</p> - <span class="summary_desc"><div class='inline'> -<p>creates a new TableStyleElement object.</p> + <span class="summary_desc"><div class='inline'><p> +creates a new TableStyleElement object. +</p> </div></span> </li> @@ -250,8 +256,9 @@ secondRowStripe, firstColumnStripe, or secondColumnStripe.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the table style element.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the table style element. +</p> </div></span> </li> @@ -272,8 +279,9 @@ secondRowStripe, firstColumnStripe, or secondColumnStripe.</p> </p><div class="docstring"> <div class="discussion"> - -<p>creates a new TableStyleElement object</p> + <p> +creates a new TableStyleElement object +</p> </div> @@ -294,8 +302,9 @@ secondRowStripe, firstColumnStripe, or secondColumnStripe.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -354,11 +363,12 @@ secondRowStripe, firstColumnStripe, or secondColumnStripe.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style_element.rb', line 49</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> - <span class='kw'>end</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -381,8 +391,9 @@ secondRowStripe, firstColumnStripe, or secondColumnStripe.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The dxfId this style element points to</p> + <p> +The dxfId this style element points to +</p> </div> @@ -416,9 +427,10 @@ secondRowStripe, firstColumnStripe, or secondColumnStripe.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style_element.rb', line 43</span> -<span class='kw'>def</span> <span class='id dxfId'>dxfId</span> - <span class='ivar'>@dxfId</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='dxfId identifier id'>dxfId</span> + <span class='@dxfId ivar id'>@dxfId</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -436,9 +448,10 @@ secondRowStripe, firstColumnStripe, or secondColumnStripe.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Number of rows or columns used in striping when the type is firstRowStripe, -secondRowStripe, firstColumnStripe, or secondColumnStripe.</p> + <p> +Number of rows or columns used in striping when the type is firstRowStripe, +secondRowStripe, firstColumnStripe, or secondColumnStripe. +</p> </div> @@ -472,9 +485,10 @@ secondRowStripe, firstColumnStripe, or secondColumnStripe.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style_element.rb', line 39</span> -<span class='kw'>def</span> <span class='id size'>size</span> - <span class='ivar'>@size</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='size identifier id'>size</span> + <span class='@size ivar id'>@size</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -492,37 +506,39 @@ secondRowStripe, firstColumnStripe, or secondColumnStripe.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The type of style element. The following type are allowed</p> - -<pre class="code"><span class='symbol'>:wholeTable</span> -<span class='symbol'>:headerRow</span> -<span class='symbol'>:totalRow</span> -<span class='symbol'>:firstColumn</span> -<span class='symbol'>:lastColumn</span> -<span class='symbol'>:firstRowStripe</span> -<span class='symbol'>:secondRowStripe</span> -<span class='symbol'>:firstColumnStripe</span> -<span class='symbol'>:secondColumnStripe</span> -<span class='symbol'>:firstHeaderCell</span> -<span class='symbol'>:lastHeaderCell</span> -<span class='symbol'>:firstTotalCell</span> -<span class='symbol'>:lastTotalCell</span> -<span class='symbol'>:firstSubtotalColumn</span> -<span class='symbol'>:secondSubtotalColumn</span> -<span class='symbol'>:thirdSubtotalColumn</span> -<span class='symbol'>:firstSubtotalRow</span> -<span class='symbol'>:secondSubtotalRow</span> -<span class='symbol'>:thirdSubtotalRow</span> -<span class='symbol'>:blankRow</span> -<span class='symbol'>:firstColumnSubheading</span> -<span class='symbol'>:secondColumnSubheading</span> -<span class='symbol'>:thirdColumnSubheading</span> -<span class='symbol'>:firstRowSubheading</span> -<span class='symbol'>:secondRowSubheading</span> -<span class='symbol'>:thirdRowSubheading</span> -<span class='symbol'>:pageFieldLabels</span> -<span class='symbol'>:pageFieldValues</span></pre> + <p> +The type of style element. The following type are allowed +</p> +<pre class="code"> + <span class='symbol val'>:wholeTable</span> + <span class='symbol val'>:headerRow</span> + <span class='symbol val'>:totalRow</span> + <span class='symbol val'>:firstColumn</span> + <span class='symbol val'>:lastColumn</span> + <span class='symbol val'>:firstRowStripe</span> + <span class='symbol val'>:secondRowStripe</span> + <span class='symbol val'>:firstColumnStripe</span> + <span class='symbol val'>:secondColumnStripe</span> + <span class='symbol val'>:firstHeaderCell</span> + <span class='symbol val'>:lastHeaderCell</span> + <span class='symbol val'>:firstTotalCell</span> + <span class='symbol val'>:lastTotalCell</span> + <span class='symbol val'>:firstSubtotalColumn</span> + <span class='symbol val'>:secondSubtotalColumn</span> + <span class='symbol val'>:thirdSubtotalColumn</span> + <span class='symbol val'>:firstSubtotalRow</span> + <span class='symbol val'>:secondSubtotalRow</span> + <span class='symbol val'>:thirdSubtotalRow</span> + <span class='symbol val'>:blankRow</span> + <span class='symbol val'>:firstColumnSubheading</span> + <span class='symbol val'>:secondColumnSubheading</span> + <span class='symbol val'>:thirdColumnSubheading</span> + <span class='symbol val'>:firstRowSubheading</span> + <span class='symbol val'>:secondRowSubheading</span> + <span class='symbol val'>:thirdRowSubheading</span> + <span class='symbol val'>:pageFieldLabels</span> + <span class='symbol val'>:pageFieldValues</span> +</pre> </div> @@ -556,9 +572,10 @@ secondRowStripe, firstColumnStripe, or secondColumnStripe.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style_element.rb', line 35</span> -<span class='kw'>def</span> <span class='id type'>type</span> - <span class='ivar'>@type</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='type identifier id'>type</span> + <span class='@type ivar id'>@type</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -580,8 +597,9 @@ secondRowStripe, firstColumnStripe, or secondColumnStripe.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the table style element</p> + <p> +Serializes the table style element +</p> </div> @@ -600,8 +618,9 @@ secondRowStripe, firstColumnStripe, or secondColumnStripe.</p> — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -635,9 +654,10 @@ secondRowStripe, firstColumnStripe, or secondColumnStripe.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style_element.rb', line 67</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id tableStyleElement'>tableStyleElement</span> <span class='kw'>self</span><span class='period'>.</span><span class='id instance_values'>instance_values</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='tableStyleElement identifier id'>tableStyleElement</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -648,9 +668,9 @@ secondRowStripe, firstColumnStripe, or secondColumnStripe.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:40 2011 by + Generated on Sun Nov 27 18:05:14 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/TableStyles.html b/doc/Axlsx/TableStyles.html index 0afdbba1..e80cc5eb 100644 --- a/doc/Axlsx/TableStyles.html +++ b/doc/Axlsx/TableStyles.html @@ -99,16 +99,18 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>Support for custom table styles does not exist in this version. Many of the + <div class='inline'><p> +Support for custom table styles does not exist in this version. Many of the classes required are defined in preparation for future release. Please do -not attempt to add custom table styles.</p> +not attempt to add custom table styles. +</p> </div> </div> - -<p>TableStyles represents a collection of style definitions for table styles -and pivot table styles.</p> +<p> +TableStyles represents a collection of style definitions for table styles +and pivot table styles. +</p> </div> @@ -144,8 +146,9 @@ and pivot table styles.</p> - <span class="summary_desc"><div class='inline'> -<p>The default pivot table style.</p> + <span class="summary_desc"><div class='inline'><p> +The default pivot table style. +</p> </div></span> </li> @@ -170,8 +173,9 @@ and pivot table styles.</p> - <span class="summary_desc"><div class='inline'> -<p>The default table style.</p> + <span class="summary_desc"><div class='inline'><p> +The default table style. +</p> </div></span> </li> @@ -216,9 +220,10 @@ and pivot table styles.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a new TableStyles object that is a container for TableStyle -objects.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new TableStyles object that is a container for TableStyle +objects. +</p> </div></span> </li> @@ -240,8 +245,9 @@ objects.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the table styles element.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the table styles element. +</p> </div></span> </li> @@ -267,8 +273,9 @@ objects.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new TableStyles object that is a container for TableStyle objects</p> + <p> +Creates a new TableStyles object that is a container for TableStyle objects +</p> </div> @@ -289,8 +296,9 @@ objects.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -340,11 +348,12 @@ objects.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_styles.rb', line 17</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='ivar'>@defaultTableStyle</span> <span class='op'>=</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:defaultTableStyle</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>TableStyleMedium9</span><span class='tstring_end'>"</span></span> - <span class='ivar'>@defaultPivotStyle</span> <span class='op'>=</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:defaultPivotStyle</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>PivotStyleLight16</span><span class='tstring_end'>"</span></span> - <span class='kw'>super</span> <span class='const'>TableStyle</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@defaultTableStyle ivar id'>@defaultTableStyle</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:defaultTableStyle</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='string val'>"TableStyleMedium9"</span> + <span class='@defaultPivotStyle ivar id'>@defaultPivotStyle</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:defaultPivotStyle</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='string val'>"PivotStyleLight16"</span> + <span class='super super kw'>super</span> <span class='TableStyle constant id'>TableStyle</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -377,8 +386,10 @@ objects.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The default pivot table style. The default value is 'PivotStyleLight6'</p> + <p> +The default pivot table style. The default value is +‘PivotStyleLight6’ +</p> </div> @@ -412,9 +423,10 @@ objects.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_styles.rb', line 12</span> -<span class='kw'>def</span> <span class='id defaultPivotStyle'>defaultPivotStyle</span> - <span class='ivar'>@defaultPivotStyle</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='defaultPivotStyle identifier id'>defaultPivotStyle</span> + <span class='@defaultPivotStyle ivar id'>@defaultPivotStyle</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -432,8 +444,10 @@ objects.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The default table style. The default value is 'TableStyleMedium9'</p> + <p> +The default table style. The default value is +‘TableStyleMedium9’ +</p> </div> @@ -467,9 +481,10 @@ objects.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_styles.rb', line 8</span> -<span class='kw'>def</span> <span class='id defaultTableStyle'>defaultTableStyle</span> - <span class='ivar'>@defaultTableStyle</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='defaultTableStyle identifier id'>defaultTableStyle</span> + <span class='@defaultTableStyle ivar id'>@defaultTableStyle</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -491,8 +506,9 @@ objects.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the table styles element</p> + <p> +Serializes the table styles element +</p> </div> @@ -511,8 +527,9 @@ objects.</p> — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -550,13 +567,14 @@ objects.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_styles.rb', line 30</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id attr'>attr</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id instance_values'>instance_values</span><span class='period'>.</span><span class='id reject'>reject</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id k'>k</span><span class='comma'>,</span> <span class='id v'>v</span><span class='op'>|</span> <span class='op'>!</span><span class='lbracket'>[</span><span class='symbol'>:defaultTableStyle</span><span class='comma'>,</span> <span class='symbol'>:defaultPivotStyle</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id include?'>include?</span><span class='lparen'>(</span><span class='id k'>k</span><span class='period'>.</span><span class='id to_sym'>to_sym</span><span class='rparen'>)</span> <span class='rbrace'>}</span> - <span class='id attr'>attr</span><span class='lbracket'>[</span><span class='symbol'>:count</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id size'>size</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id tableStyles'>tableStyles</span><span class='lparen'>(</span><span class='id attr'>attr</span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id table_style'>table_style</span><span class='op'>|</span> <span class='id table_style'>table_style</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> <span class='rbrace'>}</span> - <span class='rbrace'>}</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='attr identifier id'>attr</span> <span class='assign token'>=</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='dot token'>.</span><span class='reject identifier id'>reject</span> <span class='lbrace token'>{</span><span class='bitor op'>|</span><span class='k identifier id'>k</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='bitor op'>|</span> <span class='notop op'>!</span><span class='lbrack token'>[</span><span class='symbol val'>:defaultTableStyle</span><span class='comma token'>,</span> <span class='symbol val'>:defaultPivotStyle</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='include? fid id'>include?</span><span class='lparen token'>(</span><span class='k identifier id'>k</span><span class='dot token'>.</span><span class='to_sym identifier id'>to_sym</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> + <span class='attr identifier id'>attr</span><span class='lbrack token'>[</span><span class='symbol val'>:count</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='size identifier id'>size</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='tableStyles identifier id'>tableStyles</span><span class='lparen token'>(</span><span class='attr identifier id'>attr</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='table_style identifier id'>table_style</span><span class='bitor op'>|</span> <span class='table_style identifier id'>table_style</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -567,9 +585,9 @@ objects.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:39 2011 by + Generated on Sun Nov 27 18:05:07 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/Title.html b/doc/Axlsx/Title.html index a9d6c7c5..4c3ebdbf 100644 --- a/doc/Axlsx/Title.html +++ b/doc/Axlsx/Title.html @@ -94,8 +94,9 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>A Title stores information about the title of a chart</p> + <p> +A Title stores information about the title of a chart +</p> </div> @@ -131,8 +132,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The cell that holds the text for the title.</p> + <span class="summary_desc"><div class='inline'><p> +The cell that holds the text for the title. +</p> </div></span> </li> @@ -157,8 +159,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The text to be shown.</p> + <span class="summary_desc"><div class='inline'><p> +The text to be shown. +</p> </div></span> </li> @@ -195,8 +198,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Creates a new Title object.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new Title object. +</p> </div></span> </li> @@ -218,8 +222,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Serializes the chart title.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the chart title. +</p> </div></span> </li> @@ -240,8 +245,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new Title object</p> + <p> +Creates a new Title object +</p> </div> @@ -262,8 +268,9 @@ — - <div class='inline'> -<p>The cell or string to be used for the chart's title</p> + <div class='inline'><p> +The cell or string to be used for the chart’s title +</p> </div> </li> @@ -285,10 +292,11 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/title.rb', line 15</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id title'>title</span><span class='op'>=</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id cell'>cell</span> <span class='op'>=</span> <span class='id title'>title</span> <span class='kw'>if</span> <span class='id title'>title</span><span class='period'>.</span><span class='id is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Cell</span><span class='rparen'>)</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id text'>text</span> <span class='op'>=</span> <span class='id title'>title</span><span class='period'>.</span><span class='id to_s'>to_s</span> <span class='kw'>unless</span> <span class='id title'>title</span><span class='period'>.</span><span class='id is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Cell</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='title identifier id'>title</span><span class='assign token'>=</span><span class='string val'>""</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='cell identifier id'>cell</span> <span class='assign token'>=</span> <span class='title identifier id'>title</span> <span class='if if_mod kw'>if</span> <span class='title identifier id'>title</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Cell constant id'>Cell</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='text identifier id'>text</span> <span class='assign token'>=</span> <span class='title identifier id'>title</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span> <span class='unless unless_mod kw'>unless</span> <span class='title identifier id'>title</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Cell constant id'>Cell</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -311,9 +319,10 @@ </p><div class="docstring"> <div class="discussion"> - -<p>The cell that holds the text for the title. Setting this property will -automatically update the text attribute.</p> + <p> +The cell that holds the text for the title. Setting this property will +automatically update the text attribute. +</p> </div> @@ -347,9 +356,10 @@ automatically update the text attribute.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/title.rb', line 11</span> -<span class='kw'>def</span> <span class='id cell'>cell</span> - <span class='ivar'>@cell</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='cell identifier id'>cell</span> + <span class='@cell ivar id'>@cell</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -367,9 +377,10 @@ automatically update the text attribute.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The text to be shown. Setting this property directly with a string will -remove the cell reference.</p> + <p> +The text to be shown. Setting this property directly with a string will +remove the cell reference. +</p> </div> @@ -403,9 +414,10 @@ remove the cell reference.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/title.rb', line 7</span> -<span class='kw'>def</span> <span class='id text'>text</span> - <span class='ivar'>@text</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='text identifier id'>text</span> + <span class='@text ivar id'>@text</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -427,8 +439,9 @@ remove the cell reference.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the chart title</p> + <p> +Serializes the chart title +</p> </div> @@ -447,8 +460,9 @@ remove the cell reference.</p> — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -494,21 +508,22 @@ remove the cell reference.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/title.rb', line 44</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:title</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:tx</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:strRef</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:f</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='id cell_range'>cell_range</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='ivar'>@cell</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:strCache</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:ptCount</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='int'>1</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:pt</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:idx</span><span class='op'>=></span><span class='int'>0</span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:v</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='ivar'>@text</span><span class='rparen'>)</span> - <span class='rbrace'>}</span> - <span class='rbrace'>}</span> - <span class='rbrace'>}</span> - <span class='rbrace'>}</span> - <span class='rbrace'>}</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:title'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:tx'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:strRef'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:f'</span><span class='comma token'>,</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='cell_range identifier id'>cell_range</span><span class='lparen token'>(</span><span class='lbrack token'>[</span><span class='@cell ivar id'>@cell</span><span class='rbrack token'>]</span><span class='rparen token'>)</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:strCache'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:ptCount'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='integer val'>1</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:pt'</span><span class='comma token'>,</span> <span class='symbol val'>:idx=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:v'</span><span class='comma token'>,</span> <span class='@text ivar id'>@text</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -519,9 +534,9 @@ remove the cell reference.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:36 2011 by + Generated on Sun Nov 27 18:05:13 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/TwoCellAnchor.html b/doc/Axlsx/TwoCellAnchor.html index 8e2b5d7c..45425383 100644 --- a/doc/Axlsx/TwoCellAnchor.html +++ b/doc/Axlsx/TwoCellAnchor.html @@ -97,14 +97,16 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage drawings and charts is Worksheet#add_chart. -Anchors are specified by the :start_at and :end_at options to that method.</p> + <div class='inline'><p> +The recommended way to manage drawings and charts is Worksheet#add_chart. +Anchors are specified by the :start_at and :end_at options to that method. +</p> </div> </div> - -<p>This class details the anchor points for drawings.</p> +<p> +This class details the anchor points for drawings. +</p> </div> @@ -143,8 +145,9 @@ Anchors are specified by the :start_at and :end_at options to that method.</p> - <span class="summary_desc"><div class='inline'> -<p>The drawing that holds this anchor.</p> + <span class="summary_desc"><div class='inline'><p> +The drawing that holds this anchor. +</p> </div></span> </li> @@ -169,8 +172,9 @@ Anchors are specified by the :start_at and :end_at options to that method.</p> - <span class="summary_desc"><div class='inline'> -<p>A marker that defines the from cell anchor.</p> + <span class="summary_desc"><div class='inline'><p> +A marker that defines the from cell anchor. +</p> </div></span> </li> @@ -195,8 +199,9 @@ Anchors are specified by the :start_at and :end_at options to that method.</p> - <span class="summary_desc"><div class='inline'> -<p>The object this anchor hosts.</p> + <span class="summary_desc"><div class='inline'><p> +The object this anchor hosts. +</p> </div></span> </li> @@ -221,8 +226,9 @@ Anchors are specified by the :start_at and :end_at options to that method.</p> - <span class="summary_desc"><div class='inline'> -<p>A marker that returns the to cell anchor.</p> + <span class="summary_desc"><div class='inline'><p> +A marker that returns the to cell anchor. +</p> </div></span> </li> @@ -257,8 +263,9 @@ Anchors are specified by the :start_at and :end_at options to that method.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a graphic frame and chart object associated with this anchor.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a graphic frame and chart object associated with this anchor. +</p> </div></span> </li> @@ -280,8 +287,9 @@ Anchors are specified by the :start_at and :end_at options to that method.</p> - <span class="summary_desc"><div class='inline'> -<p>The index of this anchor in the drawing.</p> + <span class="summary_desc"><div class='inline'><p> +The index of this anchor in the drawing. +</p> </div></span> </li> @@ -305,9 +313,10 @@ Anchors are specified by the :start_at and :end_at options to that method.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a new TwoCellAnchor object and sets up a reference to the from and -to markers in the graphic_frame's chart.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new TwoCellAnchor object and sets up a reference to the from and +to markers in the graphic_frame’s chart. +</p> </div></span> </li> @@ -329,8 +338,9 @@ to markers in the graphic_frame's chart.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the two cell anchor.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the two cell anchor. +</p> </div></span> </li> @@ -354,15 +364,17 @@ to markers in the graphic_frame's chart.</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>the chart_type parameter will be replaced with object in v. 2.0.0</p> + <div class='inline'><p> +the chart_type parameter will be replaced with object in v. 2.0.0 +</p> </div> </div> - -<p>Creates a new TwoCellAnchor object and sets up a reference to the from and -to markers in the graphic_frame's chart. That means that you can do stuff -like c = worksheet.add_chart Axlsx::Chart c.start_at 5, 9</p> +<p> +Creates a new TwoCellAnchor object and sets up a reference to the from and +to markers in the graphic_frame’s chart. That means that you can do +stuff like c = worksheet.add_chart Axlsx::Chart c.start_at 5, 9 +</p> </div> @@ -392,9 +404,10 @@ like c = worksheet.add_chart Axlsx::Chart c.start_at 5, 9</p> — - <div class='inline'> -<p>This is passed to the graphic frame for instantiation. must be Chart or a -subclass of Chart</p> + <div class='inline'><p> +This is passed to the graphic frame for instantiation. must be Chart or a +subclass of Chart +</p> </div> </li> @@ -409,8 +422,9 @@ subclass of Chart</p> — - <div class='inline'> -<p>The object this anchor holds.</p> + <div class='inline'><p> +The object this anchor holds. +</p> </div> </li> @@ -427,8 +441,9 @@ subclass of Chart</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -449,8 +464,9 @@ subclass of Chart</p> <span class="default"> </span> - — <div class='inline'> -<p>the col, row to start at</p> + — <div class='inline'><p> +the col, row to start at +</p> </div> </li> @@ -460,8 +476,9 @@ subclass of Chart</p> <span class="default"> </span> - — <div class='inline'> -<p>the col, row to end at</p> + — <div class='inline'><p> +the col, row to end at +</p> </div> </li> @@ -484,11 +501,12 @@ subclass of Chart</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 38</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id drawing'>drawing</span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='ivar'>@drawing</span> <span class='op'>=</span> <span class='id drawing'>drawing</span> - <span class='id drawing'>drawing</span><span class='period'>.</span><span class='id anchors'>anchors</span> <span class='op'><<</span> <span class='kw'>self</span> - <span class='ivar'>@from</span><span class='comma'>,</span> <span class='ivar'>@to</span> <span class='op'>=</span> <span class='const'>Marker</span><span class='period'>.</span><span class='id new'>new</span><span class='comma'>,</span> <span class='const'>Marker</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='symbol'>:col</span> <span class='op'>=></span> <span class='int'>5</span><span class='comma'>,</span> <span class='symbol'>:row</span><span class='op'>=></span><span class='int'>10</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='drawing identifier id'>drawing</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@drawing ivar id'>@drawing</span> <span class='assign token'>=</span> <span class='drawing identifier id'>drawing</span> + <span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='anchors identifier id'>anchors</span> <span class='lshft op'><<</span> <span class='self self kw'>self</span> + <span class='@from ivar id'>@from</span><span class='comma token'>,</span> <span class='@to ivar id'>@to</span> <span class='assign token'>=</span> <span class='Marker constant id'>Marker</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='comma token'>,</span> <span class='Marker constant id'>Marker</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:col</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='integer val'>5</span><span class='comma token'>,</span> <span class='symbol val'>:row=</span><span class='gt op'>></span><span class='integer val'>10</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -511,8 +529,9 @@ subclass of Chart</p> </p><div class="docstring"> <div class="discussion"> - -<p>The drawing that holds this anchor</p> + <p> +The drawing that holds this anchor +</p> </div> @@ -546,9 +565,10 @@ subclass of Chart</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 25</span> -<span class='kw'>def</span> <span class='id drawing'>drawing</span> - <span class='ivar'>@drawing</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='drawing identifier id'>drawing</span> + <span class='@drawing ivar id'>@drawing</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -566,9 +586,10 @@ subclass of Chart</p> </p><div class="docstring"> <div class="discussion"> - -<p>A marker that defines the from cell anchor. The default from column and row -are 0 and 0 respectively</p> + <p> +A marker that defines the from cell anchor. The default from column and row +are 0 and 0 respectively +</p> </div> @@ -602,9 +623,10 @@ are 0 and 0 respectively</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 9</span> -<span class='kw'>def</span> <span class='id from'>from</span> - <span class='ivar'>@from</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='from identifier id'>from</span> + <span class='@from ivar id'>@from</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -622,8 +644,9 @@ are 0 and 0 respectively</p> </p><div class="docstring"> <div class="discussion"> - -<p>The object this anchor hosts</p> + <p> +The object this anchor hosts +</p> </div> @@ -657,9 +680,10 @@ are 0 and 0 respectively</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 21</span> -<span class='kw'>def</span> <span class='id object'>object</span> - <span class='ivar'>@object</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='object identifier id'>object</span> + <span class='@object ivar id'>@object</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -677,9 +701,10 @@ are 0 and 0 respectively</p> </p><div class="docstring"> <div class="discussion"> - -<p>A marker that returns the to cell anchor. The default to column and row are -5 and 10 respectively</p> + <p> +A marker that returns the to cell anchor. The default to column and row are +5 and 10 respectively +</p> </div> @@ -713,9 +738,10 @@ are 0 and 0 respectively</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 12</span> -<span class='kw'>def</span> <span class='id to'>to</span> - <span class='ivar'>@to</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to identifier id'>to</span> + <span class='@to ivar id'>@to</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -737,8 +763,9 @@ are 0 and 0 respectively</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a graphic frame and chart object associated with this anchor</p> + <p> +Creates a graphic frame and chart object associated with this anchor +</p> </div> @@ -773,10 +800,11 @@ are 0 and 0 respectively</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 46</span> -<span class='kw'>def</span> <span class='id add_chart'>add_chart</span><span class='lparen'>(</span><span class='id chart_type'>chart_type</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> - <span class='ivar'>@object</span> <span class='op'>=</span> <span class='const'>GraphicFrame</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id chart_type'>chart_type</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> - <span class='ivar'>@object</span><span class='period'>.</span><span class='id chart'>chart</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='chart_type identifier id'>chart_type</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='@object ivar id'>@object</span> <span class='assign token'>=</span> <span class='GraphicFrame constant id'>GraphicFrame</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='comma token'>,</span> <span class='chart_type identifier id'>chart_type</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='@object ivar id'>@object</span><span class='dot token'>.</span><span class='chart identifier id'>chart</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -791,8 +819,9 @@ are 0 and 0 respectively</p> </p><div class="docstring"> <div class="discussion"> - -<p>The index of this anchor in the drawing</p> + <p> +The index of this anchor in the drawing +</p> </div> @@ -826,9 +855,10 @@ are 0 and 0 respectively</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 53</span> -<span class='kw'>def</span> <span class='id index'>index</span> - <span class='ivar'>@drawing</span><span class='period'>.</span><span class='id anchors'>anchors</span><span class='period'>.</span><span class='id index'>index</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='index identifier id'>index</span> + <span class='@drawing ivar id'>@drawing</span><span class='dot token'>.</span><span class='anchors identifier id'>anchors</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -843,8 +873,9 @@ are 0 and 0 respectively</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the two cell anchor</p> + <p> +Serializes the two cell anchor +</p> </div> @@ -863,8 +894,9 @@ are 0 and 0 respectively</p> — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -908,19 +940,20 @@ are 0 and 0 respectively</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 59</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='comment'>#build it for now, break it down later! -</span> <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>xdr:twoCellAnchor</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>xdr:from</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id from'>from</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='rbrace'>}</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>xdr:to</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id to'>to</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='rbrace'>}</span> - <span class='ivar'>@object</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>xdr:clientData</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> - <span class='rbrace'>}</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='comment val'>#build it for now, break it down later!</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:twoCellAnchor'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:from'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='from identifier id'>from</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:to'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='to identifier id'>to</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='@object ivar id'>@object</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:clientData'</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -931,9 +964,9 @@ are 0 and 0 respectively</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:39 2011 by + Generated on Sun Nov 27 18:05:09 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/ValAxis.html b/doc/Axlsx/ValAxis.html index 252c78df..6e8f501c 100644 --- a/doc/Axlsx/ValAxis.html +++ b/doc/Axlsx/ValAxis.html @@ -96,8 +96,9 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>the ValAxis class defines a chart value axis.</p> + <p> +the ValAxis class defines a chart value axis. +</p> </div> @@ -133,8 +134,9 @@ - <span class="summary_desc"><div class='inline'> -<p>This element specifies how the value axis crosses the category axis.</p> + <span class="summary_desc"><div class='inline'><p> +This element specifies how the value axis crosses the category axis. +</p> </div></span> </li> @@ -179,8 +181,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Creates a new ValAxis object.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new ValAxis object. +</p> </div></span> </li> @@ -202,8 +205,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Serializes the value axis.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the value axis. +</p> </div></span> </li> @@ -229,8 +233,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new ValAxis object</p> + <p> +Creates a new ValAxis object +</p> </div> @@ -249,8 +254,9 @@ — - <div class='inline'> -<p>the id of this axis</p> + <div class='inline'><p> +the id of this axis +</p> </div> </li> @@ -265,8 +271,9 @@ — - <div class='inline'> -<p>the id of the perpendicular axis</p> + <div class='inline'><p> +the id of the perpendicular axis +</p> </div> </li> @@ -283,8 +290,9 @@ — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -355,10 +363,11 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/val_axis.rb', line 17</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id axId'>axId</span><span class='comma'>,</span> <span class='id crossAx'>crossAx</span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id crossBetween'>crossBetween</span> <span class='op'>=</span> <span class='symbol'>:between</span> - <span class='kw'>super</span><span class='lparen'>(</span><span class='id axId'>axId</span><span class='comma'>,</span> <span class='id crossAx'>crossAx</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='axId identifier id'>axId</span><span class='comma token'>,</span> <span class='crossAx identifier id'>crossAx</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='crossBetween identifier id'>crossBetween</span> <span class='assign token'>=</span> <span class='symbol val'>:between</span> + <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='axId identifier id'>axId</span><span class='comma token'>,</span> <span class='crossAx identifier id'>crossAx</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -381,9 +390,10 @@ </p><div class="docstring"> <div class="discussion"> - -<p>This element specifies how the value axis crosses the category axis. must -be one of [:between, :midCat]</p> + <p> +This element specifies how the value axis crosses the category axis. must +be one of [:between, :midCat] +</p> </div> @@ -417,9 +427,10 @@ be one of [:between, :midCat]</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/val_axis.rb', line 8</span> -<span class='kw'>def</span> <span class='id crossBetween'>crossBetween</span> - <span class='ivar'>@crossBetween</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='crossBetween identifier id'>crossBetween</span> + <span class='@crossBetween ivar id'>@crossBetween</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -441,8 +452,9 @@ be one of [:between, :midCat]</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the value axis</p> + <p> +Serializes the value axis +</p> </div> @@ -461,8 +473,9 @@ be one of [:between, :midCat]</p> — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -499,12 +512,13 @@ be one of [:between, :midCat]</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/val_axis.rb', line 27</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:valAx</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='kw'>super</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:crossBetween</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@crossBetween</span><span class='rparen'>)</span> - <span class='rbrace'>}</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:valAx'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:crossBetween'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@crossBetween ivar id'>@crossBetween</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -515,9 +529,9 @@ be one of [:between, :midCat]</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:37 2011 by + Generated on Sun Nov 27 18:05:15 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/ValAxisData.html b/doc/Axlsx/ValAxisData.html index 06cae71d..b8636123 100644 --- a/doc/Axlsx/ValAxisData.html +++ b/doc/Axlsx/ValAxisData.html @@ -98,8 +98,9 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>The ValAxisData class manages the values for a chart value series.</p> + <p> +The ValAxisData class manages the values for a chart value series. +</p> </div> @@ -155,8 +156,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Serializes the value axis data.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the value axis data. +</p> </div></span> </li> @@ -211,8 +213,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the value axis data</p> + <p> +Serializes the value axis data +</p> </div> @@ -231,8 +234,9 @@ — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -280,23 +284,24 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/val_axis_data.rb', line 8</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:val</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:numRef</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:f</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='id cell_range'>cell_range</span><span class='lparen'>(</span><span class='ivar'>@list</span><span class='rparen'>)</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:numCache</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:formatCode</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>General</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:ptCount</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='id size'>size</span><span class='rparen'>)</span> - <span class='id each_with_index'>each_with_index</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id item'>item</span><span class='comma'>,</span> <span class='id index'>index</span><span class='op'>|</span> - <span class='id v'>v</span> <span class='op'>=</span> <span class='id item'>item</span><span class='period'>.</span><span class='id is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Cell</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id item'>item</span><span class='period'>.</span><span class='id value'>value</span> <span class='op'>:</span> <span class='id item'>item</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:pt</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:idx</span><span class='op'>=></span><span class='id index'>index</span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:v</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id v'>v</span><span class='rparen'>)</span> - <span class='rbrace'>}</span> - <span class='kw'>end</span> - <span class='rbrace'>}</span> - <span class='rbrace'>}</span> - <span class='rbrace'>}</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:val'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:numRef'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:f'</span><span class='comma token'>,</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='cell_range identifier id'>cell_range</span><span class='lparen token'>(</span><span class='@list ivar id'>@list</span><span class='rparen token'>)</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:numCache'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:formatCode'</span><span class='comma token'>,</span> <span class='string val'>'General'</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:ptCount'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='size identifier id'>size</span><span class='rparen token'>)</span> + <span class='each_with_index identifier id'>each_with_index</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='item identifier id'>item</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span> + <span class='v identifier id'>v</span> <span class='assign token'>=</span> <span class='item identifier id'>item</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Cell constant id'>Cell</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='item identifier id'>item</span><span class='dot token'>.</span><span class='value identifier id'>value</span> <span class='colon op'>:</span> <span class='item identifier id'>item</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:pt'</span><span class='comma token'>,</span> <span class='symbol val'>:idx=</span><span class='gt op'>></span><span class='index identifier id'>index</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:v'</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -307,9 +312,9 @@ </div> <div id="footer"> - Generated on Sat Nov 26 13:16:38 2011 by + Generated on Sun Nov 27 18:05:15 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/View3D.html b/doc/Axlsx/View3D.html index d884bc39..6b78984f 100644 --- a/doc/Axlsx/View3D.html +++ b/doc/Axlsx/View3D.html @@ -94,8 +94,9 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>3D attributes for a chart.</p> + <p> +3D attributes for a chart. +</p> </div> @@ -111,8 +112,9 @@ <dt id="H_PERCENT_REGEX-constant" class="">H_PERCENT_REGEX = <div class="docstring"> <div class="discussion"> - -<p>Validation for hPercent</p> + <p> +Validation for hPercent +</p> </div> @@ -122,13 +124,15 @@ </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>0*(([5-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)%</span><span class='regexp_end'>/</span></span></pre></dd> + <dd><pre class="code"><span class='regexp val'>/0*(([5-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)%/</span> +</pre></dd> <dt id="DEPTH_PERCENT_REGEX-constant" class="">DEPTH_PERCENT_REGEX = <div class="docstring"> <div class="discussion"> - -<p>validation for depthPercent</p> + <p> +validation for depthPercent +</p> </div> @@ -138,7 +142,8 @@ </div> </dt> - <dd><pre class="code"><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>0*(([2-9][0-9])|([1-9][0-9][0-9])|(1[0-9][0-9][0-9])|2000)%</span><span class='regexp_end'>/</span></span></pre></dd> + <dd><pre class="code"><span class='regexp val'>/0*(([2-9][0-9])|([1-9][0-9][0-9])|(1[0-9][0-9][0-9])|2000)%/</span> +</pre></dd> </dl> @@ -166,8 +171,9 @@ - <span class="summary_desc"><div class='inline'> -<p>depth or chart as % of chart width must be between 20% and 2000%.</p> + <span class="summary_desc"><div class='inline'><p> +depth or chart as % of chart width must be between 20% and 2000%. +</p> </div></span> </li> @@ -192,8 +198,9 @@ - <span class="summary_desc"><div class='inline'> -<p>height of chart as % of chart must be between 5% and 500%.</p> + <span class="summary_desc"><div class='inline'><p> +height of chart as % of chart must be between 5% and 500%. +</p> </div></span> </li> @@ -218,8 +225,9 @@ - <span class="summary_desc"><div class='inline'> -<p>field of view angle.</p> + <span class="summary_desc"><div class='inline'><p> +field of view angle. +</p> </div></span> </li> @@ -244,8 +252,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Chart axis are at right angles.</p> + <span class="summary_desc"><div class='inline'><p> +Chart axis are at right angles. +</p> </div></span> </li> @@ -270,8 +279,9 @@ - <span class="summary_desc"><div class='inline'> -<p>x rotation for the chart must be between -90 and 90.</p> + <span class="summary_desc"><div class='inline'><p> +x rotation for the chart must be between -90 and 90. +</p> </div></span> </li> @@ -296,8 +306,9 @@ - <span class="summary_desc"><div class='inline'> -<p>y rotation for the chart must be between 0 and 360.</p> + <span class="summary_desc"><div class='inline'><p> +y rotation for the chart must be between 0 and 360. +</p> </div></span> </li> @@ -334,8 +345,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Creates a new View3D for charts.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new View3D for charts. +</p> </div></span> </li> @@ -357,8 +369,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Serializes the view3D properties.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the view3D properties. +</p> </div></span> </li> @@ -379,8 +392,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new View3D for charts</p> + <p> +Creates a new View3D for charts +</p> </div> @@ -401,8 +415,9 @@ — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -489,12 +504,13 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 46</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='ivar'>@rotX</span><span class='comma'>,</span> <span class='ivar'>@hPercent</span><span class='comma'>,</span> <span class='ivar'>@rotY</span><span class='comma'>,</span> <span class='ivar'>@depthPercent</span><span class='comma'>,</span> <span class='ivar'>@rAngAx</span><span class='comma'>,</span> <span class='ivar'>@perspective</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='kw'>nil</span> - <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span> - <span class='kw'>end</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@rotX ivar id'>@rotX</span><span class='comma token'>,</span> <span class='@hPercent ivar id'>@hPercent</span><span class='comma token'>,</span> <span class='@rotY ivar id'>@rotY</span><span class='comma token'>,</span> <span class='@depthPercent ivar id'>@depthPercent</span><span class='comma token'>,</span> <span class='@rAngAx ivar id'>@rAngAx</span><span class='comma token'>,</span> <span class='@perspective ivar id'>@perspective</span> <span class='assign token'>=</span> <span class='nil nil kw'>nil</span><span class='comma token'>,</span> <span class='nil nil kw'>nil</span><span class='comma token'>,</span> <span class='nil nil kw'>nil</span><span class='comma token'>,</span> <span class='nil nil kw'>nil</span><span class='comma token'>,</span> <span class='nil nil kw'>nil</span><span class='comma token'>,</span> <span class='nil nil kw'>nil</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -517,8 +533,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>depth or chart as % of chart width must be between 20% and 2000%</p> + <p> +depth or chart as % of chart width must be between 20% and 2000% +</p> </div> @@ -552,9 +569,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 29</span> -<span class='kw'>def</span> <span class='id depthPercent'>depthPercent</span> - <span class='ivar'>@depthPercent</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='depthPercent identifier id'>depthPercent</span> + <span class='@depthPercent ivar id'>@depthPercent</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -572,8 +590,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>height of chart as % of chart must be between 5% and 500%</p> + <p> +height of chart as % of chart must be between 5% and 500% +</p> </div> @@ -607,9 +626,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 19</span> -<span class='kw'>def</span> <span class='id hPercent'>hPercent</span> - <span class='ivar'>@hPercent</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='hPercent identifier id'>hPercent</span> + <span class='@hPercent ivar id'>@hPercent</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -627,8 +647,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>field of view angle</p> + <p> +field of view angle +</p> </div> @@ -662,9 +683,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 37</span> -<span class='kw'>def</span> <span class='id perspective'>perspective</span> - <span class='ivar'>@perspective</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='perspective identifier id'>perspective</span> + <span class='@perspective ivar id'>@perspective</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -682,8 +704,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Chart axis are at right angles</p> + <p> +Chart axis are at right angles +</p> </div> @@ -717,9 +740,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 33</span> -<span class='kw'>def</span> <span class='id rAngAx'>rAngAx</span> - <span class='ivar'>@rAngAx</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='rAngAx identifier id'>rAngAx</span> + <span class='@rAngAx ivar id'>@rAngAx</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -737,8 +761,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>x rotation for the chart must be between -90 and 90</p> + <p> +x rotation for the chart must be between -90 and 90 +</p> </div> @@ -772,9 +797,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 14</span> -<span class='kw'>def</span> <span class='id rotX'>rotX</span> - <span class='ivar'>@rotX</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='rotX identifier id'>rotX</span> + <span class='@rotX ivar id'>@rotX</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -792,8 +818,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>y rotation for the chart must be between 0 and 360</p> + <p> +y rotation for the chart must be between 0 and 360 +</p> </div> @@ -827,9 +854,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 24</span> -<span class='kw'>def</span> <span class='id rotY'>rotY</span> - <span class='ivar'>@rotY</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='rotY identifier id'>rotY</span> + <span class='@rotY ivar id'>@rotY</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -851,8 +879,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the view3D properties</p> + <p> +Serializes the view3D properties +</p> </div> @@ -871,8 +900,9 @@ — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -913,16 +943,17 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 74</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:view3D</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:rotX</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@rotX</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@rotX</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:hPercent</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@hPercent</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@hPercent</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:rotY</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@rotY</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@rotY</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:depthPercent</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@depthPercent</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@depthPercent</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:rAngAx</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@rAngAx</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@rAngAx</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:perspective</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@perspective</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@perspective</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='rbrace'>}</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:view3D'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:rotX'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@rotX ivar id'>@rotX</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@rotX ivar id'>@rotX</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:hPercent'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@hPercent ivar id'>@hPercent</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@hPercent ivar id'>@hPercent</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:rotY'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@rotY ivar id'>@rotY</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@rotY ivar id'>@rotY</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:depthPercent'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@depthPercent ivar id'>@depthPercent</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@depthPercent ivar id'>@depthPercent</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:rAngAx'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@rAngAx ivar id'>@rAngAx</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@rAngAx ivar id'>@rAngAx</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:perspective'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@perspective ivar id'>@perspective</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@perspective ivar id'>@perspective</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -933,9 +964,9 @@ </div> <div id="footer"> - Generated on Sat Nov 26 13:16:37 2011 by + Generated on Sun Nov 27 18:05:14 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/Workbook.html b/doc/Axlsx/Workbook.html index 69e4e8e0..ffb0522c 100644 --- a/doc/Axlsx/Workbook.html +++ b/doc/Axlsx/Workbook.html @@ -94,31 +94,33 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>The Workbook class is an xlsx workbook that manages worksheets, charts, + <p> +The Workbook class is an xlsx workbook that manages worksheets, charts, drawings and styles. The following parts of the Office Open XML spreadsheet -specification are not implimented in this version.</p> - -<pre class="code">bookViews -calcPr -customWorkbookViews -definedNames -externalReferences -extLst -fileRecoveryPr -fileSharing -fileVersion -functionGroups -oleSize -pivotCaches -smartTagPr -smartTagTypes -webPublishing -webPublishObjects -workbookProtection -workbookPr* - -*workbookPr is only supported to the extend of date1904</pre> +specification are not implimented in this version. +</p> +<pre class="code"> + <span class='bookViews identifier id'>bookViews</span> + <span class='calcPr identifier id'>calcPr</span> + <span class='customWorkbookViews identifier id'>customWorkbookViews</span> + <span class='definedNames identifier id'>definedNames</span> + <span class='externalReferences identifier id'>externalReferences</span> + <span class='extLst identifier id'>extLst</span> + <span class='fileRecoveryPr identifier id'>fileRecoveryPr</span> + <span class='fileSharing identifier id'>fileSharing</span> + <span class='fileVersion identifier id'>fileVersion</span> + <span class='functionGroups identifier id'>functionGroups</span> + <span class='oleSize identifier id'>oleSize</span> + <span class='pivotCaches identifier id'>pivotCaches</span> + <span class='smartTagPr identifier id'>smartTagPr</span> + <span class='smartTagTypes identifier id'>smartTagTypes</span> + <span class='webPublishing identifier id'>webPublishing</span> + <span class='webPublishObjects identifier id'>webPublishObjects</span> + <span class='workbookProtection identifier id'>workbookProtection</span> + <span class='workbookPr identifier id'>workbookPr</span><span class='mult op'>*</span> + + <span class='mult op'>*</span><span class='workbookPr identifier id'>workbookPr</span> <span class='is identifier id'>is</span> <span class='only identifier id'>only</span> <span class='supported identifier id'>supported</span> <span class='to identifier id'>to</span> <span class='the identifier id'>the</span> <span class='extend identifier id'>extend</span> <span class='of identifier id'>of</span> <span class='date1904 identifier id'>date1904</span> +</pre> </div> @@ -134,9 +136,10 @@ workbookPr* <dt id="date1904-classvariable" class="">@@date1904 = <div class="docstring"> <div class="discussion"> - -<p>Indicates if the epoc date for serialization should be 1904. If false, 1900 -is used.</p> + <p> +Indicates if the epoc date for serialization should be 1904. If false, 1900 +is used. +</p> </div> @@ -146,7 +149,8 @@ is used.</p> </div> </dt> - <dd><pre class="code"><span class='kw'>false</span></pre></dd> + <dd><pre class="code"><span class='false false kw'>false</span> +</pre></dd> </dl> @@ -174,8 +178,9 @@ is used.</p> - <span class="summary_desc"><div class='inline'> -<p>A colllection of charts associated with this workbook.</p> + <span class="summary_desc"><div class='inline'><p> +A colllection of charts associated with this workbook. +</p> </div></span> </li> @@ -200,8 +205,9 @@ is used.</p> - <span class="summary_desc"><div class='inline'> -<p>A colllection of drawings associated with this workbook.</p> + <span class="summary_desc"><div class='inline'><p> +A colllection of drawings associated with this workbook. +</p> </div></span> </li> @@ -226,8 +232,9 @@ is used.</p> - <span class="summary_desc"><div class='inline'> -<p>A colllection of images associated with this workbook.</p> + <span class="summary_desc"><div class='inline'><p> +A colllection of images associated with this workbook. +</p> </div></span> </li> @@ -252,8 +259,9 @@ is used.</p> - <span class="summary_desc"><div class='inline'> -<p>The styles associated with this workbook.</p> + <span class="summary_desc"><div class='inline'><p> +The styles associated with this workbook. +</p> </div></span> </li> @@ -278,8 +286,9 @@ is used.</p> - <span class="summary_desc"><div class='inline'> -<p>A collection of worksheets associated with this workbook.</p> + <span class="summary_desc"><div class='inline'><p> +A collection of worksheets associated with this workbook. +</p> </div></span> </li> @@ -314,8 +323,9 @@ is used.</p> - <span class="summary_desc"><div class='inline'> -<p>retrieves the date1904 attribute.</p> + <span class="summary_desc"><div class='inline'><p> +retrieves the date1904 attribute. +</p> </div></span> </li> @@ -337,8 +347,9 @@ is used.</p> - <span class="summary_desc"><div class='inline'> -<p>Sets the date1904 attribute to the provided boolean.</p> + <span class="summary_desc"><div class='inline'><p> +Sets the date1904 attribute to the provided boolean. +</p> </div></span> </li> @@ -369,8 +380,9 @@ is used.</p> - <span class="summary_desc"><div class='inline'> -<p>Adds a worksheet to this workbook.</p> + <span class="summary_desc"><div class='inline'><p> +Adds a worksheet to this workbook. +</p> </div></span> </li> @@ -392,8 +404,9 @@ is used.</p> - <span class="summary_desc"><div class='inline'> -<p>Instance level access to the class variable 1904.</p> + <span class="summary_desc"><div class='inline'><p> +Instance level access to the class variable 1904. +</p> </div></span> </li> @@ -415,8 +428,9 @@ is used.</p> - <span class="summary_desc"><div class='inline'> -<p>see @date1904.</p> + <span class="summary_desc"><div class='inline'><p> +see @date1904. +</p> </div></span> </li> @@ -440,8 +454,9 @@ is used.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a new Workbook.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new Workbook. +</p> </div></span> </li> @@ -463,8 +478,9 @@ is used.</p> - <span class="summary_desc"><div class='inline'> -<p>The workbook relationships.</p> + <span class="summary_desc"><div class='inline'><p> +The workbook relationships. +</p> </div></span> </li> @@ -486,8 +502,9 @@ is used.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the workbook document.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the workbook document. +</p> </div></span> </li> @@ -508,8 +525,9 @@ is used.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new Workbook</p> + <p> +Creates a new Workbook +</p> </div> @@ -530,8 +548,9 @@ is used.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -582,8 +601,9 @@ is used.</p> — - <div class='inline'> -<p>the object that the method was called on</p> + <div class='inline'><p> +the object that the method was called on +</p> </div> </li> @@ -609,15 +629,16 @@ is used.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 75</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='ivar'>@styles</span> <span class='op'>=</span> <span class='const'>Styles</span><span class='period'>.</span><span class='id new'>new</span> - <span class='ivar'>@worksheets</span> <span class='op'>=</span> <span class='const'>SimpleTypedList</span><span class='period'>.</span><span class='id new'>new</span> <span class='const'>Worksheet</span> - <span class='ivar'>@drawings</span> <span class='op'>=</span> <span class='const'>SimpleTypedList</span><span class='period'>.</span><span class='id new'>new</span> <span class='const'>Drawing</span> - <span class='ivar'>@charts</span> <span class='op'>=</span> <span class='const'>SimpleTypedList</span><span class='period'>.</span><span class='id new'>new</span> <span class='const'>Chart</span> - <span class='ivar'>@images</span> <span class='op'>=</span> <span class='const'>SimpleTypedList</span><span class='period'>.</span><span class='id new'>new</span> <span class='const'>Pic</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id date1904'>date1904</span><span class='op'>=</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:date1904</span><span class='rbracket'>]</span> <span class='kw'>unless</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:date1904</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='kw'>yield</span> <span class='kw'>self</span> <span class='kw'>if</span> <span class='id block_given?'>block_given?</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@styles ivar id'>@styles</span> <span class='assign token'>=</span> <span class='Styles constant id'>Styles</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='@worksheets ivar id'>@worksheets</span> <span class='assign token'>=</span> <span class='SimpleTypedList constant id'>SimpleTypedList</span><span class='dot token'>.</span><span class='new identifier id'>new</span> <span class='Worksheet constant id'>Worksheet</span> + <span class='@drawings ivar id'>@drawings</span> <span class='assign token'>=</span> <span class='SimpleTypedList constant id'>SimpleTypedList</span><span class='dot token'>.</span><span class='new identifier id'>new</span> <span class='Drawing constant id'>Drawing</span> + <span class='@charts ivar id'>@charts</span> <span class='assign token'>=</span> <span class='SimpleTypedList constant id'>SimpleTypedList</span><span class='dot token'>.</span><span class='new identifier id'>new</span> <span class='Chart constant id'>Chart</span> + <span class='@images ivar id'>@images</span> <span class='assign token'>=</span> <span class='SimpleTypedList constant id'>SimpleTypedList</span><span class='dot token'>.</span><span class='new identifier id'>new</span> <span class='Pic constant id'>Pic</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='date1904 identifier id'>date1904</span><span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:date1904</span><span class='rbrack token'>]</span> <span class='unless unless_mod kw'>unless</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:date1904</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='yield yield kw'>yield</span> <span class='self self kw'>self</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -643,13 +664,15 @@ is used.</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage charts is Worksheet#add_chart</p> + <div class='inline'><p> +The recommended way to manage charts is Worksheet#add_chart +</p> </div> </div> - -<p>A colllection of charts associated with this workbook</p> +<p> +A colllection of charts associated with this workbook +</p> </div> @@ -692,9 +715,10 @@ is used.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 45</span> -<span class='kw'>def</span> <span class='id charts'>charts</span> - <span class='ivar'>@charts</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='charts identifier id'>charts</span> + <span class='@charts ivar id'>@charts</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -715,13 +739,15 @@ is used.</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage drawings is Worksheet#add_chart</p> + <div class='inline'><p> +The recommended way to manage drawings is Worksheet#add_chart +</p> </div> </div> - -<p>A colllection of drawings associated with this workbook</p> +<p> +A colllection of drawings associated with this workbook +</p> </div> @@ -764,9 +790,10 @@ is used.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 59</span> -<span class='kw'>def</span> <span class='id drawings'>drawings</span> - <span class='ivar'>@drawings</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='drawings identifier id'>drawings</span> + <span class='@drawings ivar id'>@drawings</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -787,13 +814,15 @@ is used.</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage images is Worksheet#add_image</p> + <div class='inline'><p> +The recommended way to manage images is Worksheet#add_image +</p> </div> </div> - -<p>A colllection of images associated with this workbook</p> +<p> +A colllection of images associated with this workbook +</p> </div> @@ -836,9 +865,10 @@ is used.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 52</span> -<span class='kw'>def</span> <span class='id images'>images</span> - <span class='ivar'>@images</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='images identifier id'>images</span> + <span class='@images ivar id'>@images</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -859,13 +889,15 @@ is used.</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage styles is Styles#add_style</p> + <div class='inline'><p> +The recommended way to manage styles is Styles#add_style +</p> </div> </div> - -<p>The styles associated with this workbook</p> +<p> +The styles associated with this workbook +</p> </div> @@ -908,9 +940,10 @@ is used.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 66</span> -<span class='kw'>def</span> <span class='id styles'>styles</span> - <span class='ivar'>@styles</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='styles identifier id'>styles</span> + <span class='@styles ivar id'>@styles</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -931,13 +964,15 @@ is used.</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage worksheets is add_worksheet</p> + <div class='inline'><p> +The recommended way to manage worksheets is add_worksheet +</p> </div> </div> - -<p>A collection of worksheets associated with this workbook.</p> +<p> +A collection of worksheets associated with this workbook. +</p> </div> @@ -980,9 +1015,10 @@ is used.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 38</span> -<span class='kw'>def</span> <span class='id worksheets'>worksheets</span> - <span class='ivar'>@worksheets</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='worksheets identifier id'>worksheets</span> + <span class='@worksheets ivar id'>@worksheets</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1004,8 +1040,9 @@ is used.</p> </p><div class="docstring"> <div class="discussion"> - -<p>retrieves the date1904 attribute</p> + <p> +retrieves the date1904 attribute +</p> </div> @@ -1037,7 +1074,8 @@ is used.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 98</span> -<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id date1904'>date1904</span><span class='lparen'>(</span><span class='rparen'>)</span> <span class='cvar'>@@date1904</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='date1904 identifier id'>date1904</span><span class='lparen token'>(</span><span class='rparen token'>)</span> <span class='@@date1904 ivar id'>@@date1904</span><span class='semicolon token'>;</span> <span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1052,8 +1090,9 @@ is used.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Sets the date1904 attribute to the provided boolean</p> + <p> +Sets the date1904 attribute to the provided boolean +</p> </div> @@ -1085,7 +1124,8 @@ is used.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 94</span> -<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id date1904='>date1904=</span><span class='lparen'>(</span><span class='id v'>v</span><span class='rparen'>)</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='id validate_boolean'>validate_boolean</span> <span class='id v'>v</span><span class='semicolon'>;</span> <span class='cvar'>@@date1904</span> <span class='op'>=</span> <span class='id v'>v</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='date1904 identifier id'>date1904</span><span class='assign token'>=</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='validate_boolean identifier id'>validate_boolean</span> <span class='v identifier id'>v</span><span class='semicolon token'>;</span> <span class='@@date1904 ivar id'>@@date1904</span> <span class='assign token'>=</span> <span class='v identifier id'>v</span> <span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1106,8 +1146,9 @@ is used.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Adds a worksheet to this workbook</p> + <p> +Adds a worksheet to this workbook +</p> </div> @@ -1128,8 +1169,9 @@ is used.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -1148,8 +1190,9 @@ is used.</p> <span class="default"> </span> - — <div class='inline'> -<p>The name of the worksheet.</p> + — <div class='inline'><p> +The name of the worksheet. +</p> </div> </li> @@ -1205,11 +1248,12 @@ is used.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 104</span> -<span class='kw'>def</span> <span class='id add_worksheet'>add_worksheet</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='id worksheet'>worksheet</span> <span class='op'>=</span> <span class='const'>Worksheet</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> - <span class='kw'>yield</span> <span class='id worksheet'>worksheet</span> <span class='kw'>if</span> <span class='id block_given?'>block_given?</span> - <span class='id worksheet'>worksheet</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='add_worksheet identifier id'>add_worksheet</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='worksheet identifier id'>worksheet</span> <span class='assign token'>=</span> <span class='Worksheet constant id'>Worksheet</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='yield yield kw'>yield</span> <span class='worksheet identifier id'>worksheet</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> + <span class='worksheet identifier id'>worksheet</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1224,8 +1268,9 @@ is used.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Instance level access to the class variable 1904</p> + <p> +Instance level access to the class variable 1904 +</p> </div> @@ -1257,7 +1302,8 @@ is used.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 87</span> -<span class='kw'>def</span> <span class='id date1904'>date1904</span><span class='lparen'>(</span><span class='rparen'>)</span> <span class='cvar'>@@date1904</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='date1904 identifier id'>date1904</span><span class='lparen token'>(</span><span class='rparen token'>)</span> <span class='@@date1904 ivar id'>@@date1904</span><span class='semicolon token'>;</span> <span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1272,8 +1318,9 @@ is used.</p> </p><div class="docstring"> <div class="discussion"> - -<p>see @date1904</p> + <p> +see @date1904 +</p> </div> @@ -1292,7 +1339,8 @@ is used.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 90</span> -<span class='kw'>def</span> <span class='id date1904='>date1904=</span><span class='lparen'>(</span><span class='id v'>v</span><span class='rparen'>)</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='id validate_boolean'>validate_boolean</span> <span class='id v'>v</span><span class='semicolon'>;</span> <span class='cvar'>@@date1904</span> <span class='op'>=</span> <span class='id v'>v</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='date1904= identifier id'>date1904=</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='validate_boolean identifier id'>validate_boolean</span> <span class='v identifier id'>v</span><span class='semicolon token'>;</span> <span class='@@date1904 ivar id'>@@date1904</span> <span class='assign token'>=</span> <span class='v identifier id'>v</span> <span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1307,8 +1355,9 @@ is used.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The workbook relationships. This is managed automatically by the workbook</p> + <p> +The workbook relationships. This is managed automatically by the workbook +</p> </div> @@ -1347,14 +1396,15 @@ is used.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 112</span> -<span class='kw'>def</span> <span class='id relationships'>relationships</span> - <span class='id r'>r</span> <span class='op'>=</span> <span class='const'>Relationships</span><span class='period'>.</span><span class='id new'>new</span> - <span class='ivar'>@worksheets</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id sheet'>sheet</span><span class='op'>|</span> - <span class='id r'>r</span> <span class='op'><<</span> <span class='const'>Relationship</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='const'>WORKSHEET_R</span><span class='comma'>,</span> <span class='const'>WORKSHEET_PN</span> <span class='op'>%</span> <span class='lparen'>(</span><span class='id r'>r</span><span class='period'>.</span><span class='id size'>size</span><span class='op'>+</span><span class='int'>1</span><span class='rparen'>)</span><span class='rparen'>)</span> - <span class='kw'>end</span> - <span class='id r'>r</span> <span class='op'><<</span> <span class='const'>Relationship</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='const'>STYLES_R</span><span class='comma'>,</span> <span class='const'>STYLES_PN</span><span class='rparen'>)</span> - <span class='id r'>r</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='relationships identifier id'>relationships</span> + <span class='r identifier id'>r</span> <span class='assign token'>=</span> <span class='Relationships constant id'>Relationships</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='@worksheets ivar id'>@worksheets</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span> + <span class='r identifier id'>r</span> <span class='lshft op'><<</span> <span class='Relationship constant id'>Relationship</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='WORKSHEET_R constant id'>WORKSHEET_R</span><span class='comma token'>,</span> <span class='WORKSHEET_PN constant id'>WORKSHEET_PN</span> <span class='mod op'>%</span> <span class='lparen token'>(</span><span class='r identifier id'>r</span><span class='dot token'>.</span><span class='size identifier id'>size</span><span class='plus op'>+</span><span class='integer val'>1</span><span class='rparen token'>)</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> + <span class='r identifier id'>r</span> <span class='lshft op'><<</span> <span class='Relationship constant id'>Relationship</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='STYLES_R constant id'>STYLES_R</span><span class='comma token'>,</span> <span class='STYLES_PN constant id'>STYLES_PN</span><span class='rparen token'>)</span> + <span class='r identifier id'>r</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1369,8 +1419,9 @@ is used.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the workbook document</p> + <p> +Serializes the workbook document +</p> </div> @@ -1415,20 +1466,21 @@ is used.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 123</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='rparen'>)</span> - <span class='id add_worksheet'>add_worksheet</span> <span class='kw'>unless</span> <span class='id worksheets'>worksheets</span><span class='period'>.</span><span class='id size'>size</span> <span class='op'>></span> <span class='int'>0</span> - <span class='id builder'>builder</span> <span class='op'>=</span> <span class='const'>Nokogiri</span><span class='op'>::</span><span class='const'>XML</span><span class='op'>::</span><span class='const'>Builder</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='symbol'>:encoding</span> <span class='op'>=></span> <span class='const'>ENCODING</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id xml'>xml</span><span class='op'>|</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='lparen'>(</span><span class='symbol'>:xmlns</span> <span class='op'>=></span> <span class='const'>XML_NS</span><span class='comma'>,</span> <span class='symbol'>:xmlns:r</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='const'>XML_NS_R</span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id workbookPr'>workbookPr</span><span class='lparen'>(</span><span class='symbol'>:date1904</span><span class='op'>=></span><span class='cvar'>@@date1904</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id sheets'>sheets</span> <span class='lbrace'>{</span> - <span class='ivar'>@worksheets</span><span class='period'>.</span><span class='id each_with_index'>each_with_index</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id sheet'>sheet</span><span class='comma'>,</span> <span class='id index'>index</span><span class='op'>|</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id sheet'>sheet</span><span class='lparen'>(</span><span class='symbol'>:name</span><span class='op'>=></span><span class='id sheet'>sheet</span><span class='period'>.</span><span class='id name'>name</span><span class='comma'>,</span> <span class='symbol'>:sheetId</span><span class='op'>=></span><span class='id index'>index</span><span class='op'>+</span><span class='int'>1</span><span class='comma'>,</span> <span class='symbol'>:r:id</span><span class='tstring_end'>"</span></span><span class='op'>=></span><span class='id sheet'>sheet</span><span class='period'>.</span><span class='id rId'>rId</span><span class='rparen'>)</span> - <span class='kw'>end</span> - <span class='rbrace'>}</span> - <span class='rbrace'>}</span> - <span class='kw'>end</span> - <span class='id builder'>builder</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='symbol'>:indent</span><span class='op'>=></span><span class='int'>0</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='rparen token'>)</span> + <span class='add_worksheet identifier id'>add_worksheet</span> <span class='unless unless_mod kw'>unless</span> <span class='worksheets identifier id'>worksheets</span><span class='dot token'>.</span><span class='size identifier id'>size</span> <span class='gt op'>></span> <span class='integer val'>0</span> + <span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='lparen token'>(</span><span class='symbol val'>:xmlns</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS constant id'>XML_NS</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:r'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS_R constant id'>XML_NS_R</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='workbookPr identifier id'>workbookPr</span><span class='lparen token'>(</span><span class='symbol val'>:date1904=</span><span class='gt op'>></span><span class='@@date1904 ivar id'>@@date1904</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='sheets identifier id'>sheets</span> <span class='lbrace token'>{</span> + <span class='@worksheets ivar id'>@worksheets</span><span class='dot token'>.</span><span class='each_with_index identifier id'>each_with_index</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='sheet identifier id'>sheet</span><span class='lparen token'>(</span><span class='symbol val'>:name=</span><span class='gt op'>></span><span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='symbol val'>:sheetId=</span><span class='gt op'>></span><span class='index identifier id'>index</span><span class='plus op'>+</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='symbol val'>:"r:id"</span><span class='assign token'>=</span><span class='gt op'>></span><span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rId identifier id'>rId</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='symbol val'>:indent=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1439,9 +1491,9 @@ is used.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:38 2011 by + Generated on Sun Nov 27 18:05:08 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/Worksheet.html b/doc/Axlsx/Worksheet.html index db1e39f7..05bc4c18 100644 --- a/doc/Axlsx/Worksheet.html +++ b/doc/Axlsx/Worksheet.html @@ -94,8 +94,9 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>The Worksheet class represents a worksheet in the workbook.</p> + <p> +The Worksheet class represents a worksheet in the workbook. +</p> </div> @@ -127,8 +128,9 @@ - <span class="summary_desc"><div class='inline'> -<p>An array of content based calculated column widths.</p> + <span class="summary_desc"><div class='inline'><p> +An array of content based calculated column widths. +</p> </div></span> </li> @@ -153,8 +155,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The name of the worksheet.</p> + <span class="summary_desc"><div class='inline'><p> +The name of the worksheet. +</p> </div></span> </li> @@ -179,8 +182,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The rows in this worksheet.</p> + <span class="summary_desc"><div class='inline'><p> +The rows in this worksheet. +</p> </div></span> </li> @@ -205,8 +209,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The workbook that owns this worksheet.</p> + <span class="summary_desc"><div class='inline'><p> +The workbook that owns this worksheet. +</p> </div></span> </li> @@ -241,8 +246,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Adds a chart to this worksheets drawing.</p> + <span class="summary_desc"><div class='inline'><p> +Adds a chart to this worksheets drawing. +</p> </div></span> </li> @@ -264,8 +270,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Adds a media item to the worksheets drawing.</p> + <span class="summary_desc"><div class='inline'><p> +Adds a media item to the worksheets drawing. +</p> </div></span> </li> @@ -287,8 +294,57 @@ - <span class="summary_desc"><div class='inline'> -<p>Adds a row to the worksheet and updates auto fit data.</p> + <span class="summary_desc"><div class='inline'><p> +Adds a row to the worksheet and updates auto fit data. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#auto_width-instance_method" title="#auto_width (instance method)">- (Float) <strong>auto_width</strong>(col) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Determines the proper width for a column based on content. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#col_style-instance_method" title="#col_style (instance method)">- (Object) <strong>col_style</strong>(index, style, options = {}) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Set the style for cells in a specific column. +</p> </div></span> </li> @@ -310,8 +366,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The drawing associated with this worksheet.</p> + <span class="summary_desc"><div class='inline'><p> +The drawing associated with this worksheet. +</p> </div></span> </li> @@ -333,8 +390,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The index of this worksheet in the owning Workbook's worksheets list.</p> + <span class="summary_desc"><div class='inline'><p> +The index of this worksheet in the owning Workbook’s worksheets list. +</p> </div></span> </li> @@ -358,8 +416,9 @@ - <span class="summary_desc"><div class='inline'> -<p>Creates a new worksheet.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new worksheet. +</p> </div></span> </li> @@ -381,8 +440,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The part name of this worksheet.</p> + <span class="summary_desc"><div class='inline'><p> +The part name of this worksheet. +</p> </div></span> </li> @@ -404,8 +464,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The worksheet relationships.</p> + <span class="summary_desc"><div class='inline'><p> +The worksheet relationships. +</p> </div></span> </li> @@ -427,8 +488,9 @@ - <span class="summary_desc"><div class='inline'> -<p>The relationship part name of this worksheet.</p> + <span class="summary_desc"><div class='inline'><p> +The relationship part name of this worksheet. +</p> </div></span> </li> @@ -450,8 +512,33 @@ - <span class="summary_desc"><div class='inline'> -<p>The relationship Id of thiw worksheet.</p> + <span class="summary_desc"><div class='inline'><p> +The relationship Id of thiw worksheet. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#row_style-instance_method" title="#row_style (instance method)">- (Object) <strong>row_style</strong>(index, style, options = {}) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Set the style for cells in a specific row. +</p> </div></span> </li> @@ -473,8 +560,33 @@ - <span class="summary_desc"><div class='inline'> -<p>Serializes the worksheet document.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the worksheet document. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#update_auto_fit_data-instance_method" title="#update_auto_fit_data (instance method)">- (Array) <strong>update_auto_fit_data</strong>(cells) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Updates auto fit data. +</p> </div></span> </li> @@ -498,13 +610,15 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>the recommended way to manage worksheets is Workbook#add_worksheet</p> + <div class='inline'><p> +the recommended way to manage worksheets is Workbook#add_worksheet +</p> </div> </div> - -<p>Creates a new worksheet.</p> +<p> +Creates a new worksheet. +</p> </div> @@ -525,8 +639,9 @@ — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -547,8 +662,9 @@ <span class="default"> </span> - — <div class='inline'> -<p>The name of this sheet.</p> + — <div class='inline'><p> +The name of this sheet. +</p> </div> </li> @@ -582,15 +698,16 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 34</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id wb'>wb</span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='ivar'>@drawing</span> <span class='op'>=</span> <span class='kw'>nil</span> - <span class='ivar'>@rows</span> <span class='op'>=</span> <span class='const'>SimpleTypedList</span><span class='period'>.</span><span class='id new'>new</span> <span class='const'>Row</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id workbook'>workbook</span> <span class='op'>=</span> <span class='id wb'>wb</span> - <span class='ivar'>@workbook</span><span class='period'>.</span><span class='id worksheets'>worksheets</span> <span class='op'><<</span> <span class='kw'>self</span> - <span class='ivar'>@auto_fit_data</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id name'>name</span> <span class='op'>=</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Sheet</span><span class='tstring_end'>"</span></span> <span class='op'>+</span> <span class='lparen'>(</span><span class='id index'>index</span><span class='op'>+</span><span class='int'>1</span><span class='rparen'>)</span><span class='period'>.</span><span class='id to_s'>to_s</span> - <span class='ivar'>@magick_draw</span> <span class='op'>=</span> <span class='const'>Magick</span><span class='op'>::</span><span class='const'>Draw</span><span class='period'>.</span><span class='id new'>new</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='wb identifier id'>wb</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@drawing ivar id'>@drawing</span> <span class='assign token'>=</span> <span class='nil nil kw'>nil</span> + <span class='@rows ivar id'>@rows</span> <span class='assign token'>=</span> <span class='SimpleTypedList constant id'>SimpleTypedList</span><span class='dot token'>.</span><span class='new identifier id'>new</span> <span class='Row constant id'>Row</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span> <span class='assign token'>=</span> <span class='wb identifier id'>wb</span> + <span class='@workbook ivar id'>@workbook</span><span class='dot token'>.</span><span class='worksheets identifier id'>worksheets</span> <span class='lshft op'><<</span> <span class='self self kw'>self</span> + <span class='@auto_fit_data ivar id'>@auto_fit_data</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='name identifier id'>name</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:name</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='string val'>"Sheet"</span> <span class='plus op'>+</span> <span class='lparen token'>(</span><span class='index identifier id'>index</span><span class='plus op'>+</span><span class='integer val'>1</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span> + <span class='@magick_draw ivar id'>@magick_draw</span> <span class='assign token'>=</span> <span class='Magick constant id'>Magick</span><span class='colon2 op'>::</span><span class='Draw constant id'>Draw</span><span class='dot token'>.</span><span class='new identifier id'>new</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -616,14 +733,16 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>a single auto fit data item is a hash with :longest => [String] and -:sz=> [Integer] members.</p> + <div class='inline'><p> +a single auto fit data item is a hash with :longest => [String] and +:sz=> [Integer] members. +</p> </div> </div> - -<p>An array of content based calculated column widths.</p> +<p> +An array of content based calculated column widths. +</p> </div> @@ -641,8 +760,9 @@ — - <div class='inline'> -<p>of Hash</p> + <div class='inline'><p> +of Hash +</p> </div> </li> @@ -662,9 +782,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 25</span> -<span class='kw'>def</span> <span class='id auto_fit_data'>auto_fit_data</span> - <span class='ivar'>@auto_fit_data</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='auto_fit_data identifier id'>auto_fit_data</span> + <span class='@auto_fit_data ivar id'>@auto_fit_data</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -682,8 +803,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>The name of the worksheet</p> + <p> +The name of the worksheet +</p> </div> @@ -717,9 +839,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 9</span> -<span class='kw'>def</span> <span class='id name'>name</span> - <span class='ivar'>@name</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='name identifier id'>name</span> + <span class='@name ivar id'>@name</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -740,13 +863,15 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage rows is Worksheet#add_row</p> + <div class='inline'><p> +The recommended way to manage rows is Worksheet#add_row +</p> </div> </div> - -<p>The rows in this worksheet</p> +<p> +The rows in this worksheet +</p> </div> @@ -787,9 +912,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 20</span> -<span class='kw'>def</span> <span class='id rows'>rows</span> - <span class='ivar'>@rows</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='rows identifier id'>rows</span> + <span class='@rows ivar id'>@rows</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -807,8 +933,9 @@ </p><div class="docstring"> <div class="discussion"> - -<p>The workbook that owns this worksheet</p> + <p> +The workbook that owns this worksheet +</p> </div> @@ -842,9 +969,10 @@ <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 13</span> -<span class='kw'>def</span> <span class='id workbook'>workbook</span> - <span class='ivar'>@workbook</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='workbook identifier id'>workbook</span> + <span class='@workbook ivar id'>@workbook</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -869,16 +997,18 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>each chart type also specifies additional options</p> + <div class='inline'><p> +each chart type also specifies additional options +</p> </div> </div> - -<p>Adds a chart to this worksheets drawing. This is the recommended way to +<p> +Adds a chart to this worksheets drawing. This is the recommended way to create charts for your worksheet. This method wraps the complexity of dealing with ooxml drawing, anchors, markers graphic frames chart objects -and all the other dirty details.</p> +and all the other dirty details. +</p> </div> @@ -910,8 +1040,9 @@ and all the other dirty details.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -1009,20 +1140,21 @@ and all the other dirty details.</p> <pre class="lines"> -105 -106 -107 -108 -109</pre> +132 +133 +134 +135 +136</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 105</span> - -<span class='kw'>def</span> <span class='id add_chart'>add_chart</span><span class='lparen'>(</span><span class='id chart_type'>chart_type</span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='id chart'>chart</span> <span class='op'>=</span> <span class='id drawing'>drawing</span><span class='period'>.</span><span class='id add_chart'>add_chart</span><span class='lparen'>(</span><span class='id chart_type'>chart_type</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> - <span class='kw'>yield</span> <span class='id chart'>chart</span> <span class='kw'>if</span> <span class='id block_given?'>block_given?</span> - <span class='id chart'>chart</span> -<span class='kw'>end</span></pre> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 132</span> + +<span class='def def kw'>def</span> <span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='chart_type identifier id'>chart_type</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='chart identifier id'>chart</span> <span class='assign token'>=</span> <span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='chart_type identifier id'>chart_type</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='yield yield kw'>yield</span> <span class='chart identifier id'>chart</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> + <span class='chart identifier id'>chart</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1037,8 +1169,9 @@ and all the other dirty details.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Adds a media item to the worksheets drawing</p> + <p> +Adds a media item to the worksheets drawing +</p> </div> @@ -1070,8 +1203,9 @@ and all the other dirty details.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -1090,8 +1224,9 @@ and all the other dirty details.</p> <span class="default"> </span> - — <div class='inline'> -<p>unknown</p> + — <div class='inline'><p> +unknown +</p> </div> </li> @@ -1118,20 +1253,21 @@ and all the other dirty details.</p> <pre class="lines"> -114 -115 -116 -117 -118</pre> +141 +142 +143 +144 +145</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 114</span> - -<span class='kw'>def</span> <span class='id add_image'>add_image</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='id image'>image</span> <span class='op'>=</span> <span class='id drawing'>drawing</span><span class='period'>.</span><span class='id add_image'>add_image</span><span class='lparen'>(</span><span class='id options'>options</span><span class='rparen'>)</span> - <span class='kw'>yield</span> <span class='id image'>image</span> <span class='kw'>if</span> <span class='id block_given?'>block_given?</span> - <span class='id image'>image</span> -<span class='kw'>end</span></pre> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 141</span> + +<span class='def def kw'>def</span> <span class='add_image identifier id'>add_image</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='image identifier id'>image</span> <span class='assign token'>=</span> <span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='add_image identifier id'>add_image</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='yield yield kw'>yield</span> <span class='image identifier id'>image</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> + <span class='image identifier id'>image</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1146,8 +1282,9 @@ and all the other dirty details.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Adds a row to the worksheet and updates auto fit data</p> + <p> +Adds a row to the worksheet and updates auto fit data +</p> </div> @@ -1168,8 +1305,9 @@ and all the other dirty details.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -1257,12 +1395,277 @@ and all the other dirty details.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 85</span> -<span class='kw'>def</span> <span class='id add_row'>add_row</span><span class='lparen'>(</span><span class='id values'>values</span><span class='op'>=</span><span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='const'>Row</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id values'>values</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> - <span class='id update_auto_fit_data'>update_auto_fit_data</span> <span class='ivar'>@rows</span><span class='period'>.</span><span class='id last'>last</span><span class='period'>.</span><span class='id cells'>cells</span> - <span class='kw'>yield</span> <span class='ivar'>@rows</span><span class='period'>.</span><span class='id last'>last</span> <span class='kw'>if</span> <span class='id block_given?'>block_given?</span> - <span class='ivar'>@rows</span><span class='period'>.</span><span class='id last'>last</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='add_row identifier id'>add_row</span><span class='lparen token'>(</span><span class='values identifier id'>values</span><span class='assign token'>=</span><span class='lbrack token'>[</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='Row constant id'>Row</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='comma token'>,</span> <span class='values identifier id'>values</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='update_auto_fit_data identifier id'>update_auto_fit_data</span> <span class='@rows ivar id'>@rows</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span> + <span class='yield yield kw'>yield</span> <span class='@rows ivar id'>@rows</span><span class='dot token'>.</span><span class='last identifier id'>last</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> + <span class='@rows ivar id'>@rows</span><span class='dot token'>.</span><span class='last identifier id'>last</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="auto_width-instance_method"> + + - (<tt>Float</tt>) <strong>auto_width</strong>(col) + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +From ECMA docs +</p> +<pre class="code"> + <span class='Column constant id'>Column</span> <span class='width identifier id'>width</span> <span class='measured identifier id'>measured</span> <span class='as identifier id'>as</span> <span class='the identifier id'>the</span> <span class='number identifier id'>number</span> <span class='of identifier id'>of</span> <span class='characters identifier id'>characters</span> <span class='of identifier id'>of</span> <span class='the identifier id'>the</span> <span class='maximum identifier id'>maximum</span> <span class='digit identifier id'>digit</span> <span class='width identifier id'>width</span> <span class='of identifier id'>of</span> <span class='the identifier id'>the</span> <span class='numbers identifier id'>numbers</span> <span class='integer val'>0</span> <span class='dot2 op'>..</span> <span class='integer val'>9</span> <span class='as identifier id'>as</span> + <span class='rendered identifier id'>rendered</span> <span class='in in kw'>in</span> <span class='the identifier id'>the</span> <span class='normal identifier id'>normal</span> <span class='style identifier id'>style</span><span class='string val'>'s font. There are 4 pixels of margin padding (two on each side), plus 1 pixel padding for the gridlines. + width = Truncate([!{Number of Characters} * !{Maximum Digit Width} + !{5 pixel padding}]/{Maximum Digit Width}*256)/256 +</span></pre> +</div> + </div> + +<p> +Determines the proper width for a column based on content. +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>A</span> + + + <span class='type'>(<tt>Hash</tt>)</span> + + + + — + <div class='inline'><p> +hash of auto_fit_data +</p> +</div> + + </li> + +</ul> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Float</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 216</span> + +<span class='def def kw'>def</span> <span class='auto_width identifier id'>auto_width</span><span class='lparen token'>(</span><span class='col identifier id'>col</span><span class='rparen token'>)</span> + <span class='mdw identifier id'>mdw</span> <span class='assign token'>=</span> <span class='float val'>6.0</span> <span class='comment val'># maximum digit with is always 6.0 with RMagick's default font</span> + <span class='mdw_count identifier id'>mdw_count</span> <span class='assign token'>=</span> <span class='integer val'>0</span> + <span class='best_guess identifier id'>best_guess</span> <span class='assign token'>=</span> <span class='float val'>1.5</span> <span class='comment val'>#direct testing shows the results of the documented formula to be a bit too small. This is a best guess scaling</span> + <span class='font_scale identifier id'>font_scale</span> <span class='assign token'>=</span> <span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:sz</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='to_f identifier id'>to_f</span> <span class='div op'>/</span> <span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='fonts identifier id'>fonts</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='sz identifier id'>sz</span><span class='dot token'>.</span><span class='to_f identifier id'>to_f</span> <span class='orop op'>||</span> <span class='float val'>11.0</span><span class='rparen token'>)</span> + + <span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:longest</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='scan identifier id'>scan</span><span class='lparen token'>(</span><span class='regexp val'>/./</span><span class='mu identifier id'>mu</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='i identifier id'>i</span><span class='bitor op'>|</span> + <span class='mdw_count identifier id'>mdw_count</span> <span class='opasgn op'>+=</span><span class='integer val'>1</span> <span class='if if_mod kw'>if</span> <span class='@magick_draw ivar id'>@magick_draw</span><span class='dot token'>.</span><span class='get_type_metrics identifier id'>get_type_metrics</span><span class='lparen token'>(</span><span class='i identifier id'>i</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='width identifier id'>width</span> <span class='geq op'>>=</span> <span class='mdw identifier id'>mdw</span> + <span class='end end kw'>end</span> + <span class='lparen token'>(</span><span class='lparen token'>(</span><span class='mdw_count identifier id'>mdw_count</span> <span class='mult op'>*</span> <span class='mdw identifier id'>mdw</span> <span class='plus op'>+</span> <span class='integer val'>5</span><span class='rparen token'>)</span> <span class='div op'>/</span> <span class='mdw identifier id'>mdw</span> <span class='mult op'>*</span> <span class='integer val'>256</span><span class='rparen token'>)</span> <span class='div op'>/</span> <span class='float val'>256.0</span> <span class='mult op'>*</span> <span class='best_guess identifier id'>best_guess</span> <span class='mult op'>*</span> <span class='font_scale identifier id'>font_scale</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="col_style-instance_method"> + + - (<tt>Object</tt>) <strong>col_style</strong>(index, style, options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +You can also specify the style for specific columns in the call to add_row +by using an array for the :styles option +</p> +</div> + </div> + +<p> +Set the style for cells in a specific column +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>index</span> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +the index of the column +</p> +</div> + + </li> + + <li> + + <span class='name'>the</span> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +cellXfs index +</p> +</div> + + </li> + + <li> + + <span class='name'>options</span> + + + <span class='type'>(<tt>Hash</tt>)</span> + + + <em class="default">(defaults to: <tt>{}</tt>)</em> + + + — + <div class='inline'><p> +a customizable set of options +</p> +</div> + + </li> + +</ul> + + + + + + + + + <h3>Options Hash (<tt>options</tt>):</h3> + <ul class="option"> + + <li> + <span class="name">row_offset</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + — <div class='inline'><p> +only cells after this column will be updated. +</p> +</div> + </li> + + </ul> + + +<h3>Raises:</h3> +<ul class="raise"> + + <li> + + + <span class='type'>(<tt>ArgumentError</tt>)</span> + + + + </li> + +</ul> + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="#add_row-instance_method" title="Axlsx::Worksheet#add_row (method)">#add_row</a></span></li> + + <li>for an example</li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +113 +114 +115 +116 +117</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 113</span> + +<span class='def def kw'>def</span> <span class='col_style identifier id'>col_style</span><span class='lparen token'>(</span><span class='index identifier id'>index</span><span class='comma token'>,</span> <span class='style identifier id'>style</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='string val'>"Invalid Column Index"</span> <span class='unless unless_mod kw'>unless</span> <span class='index identifier id'>index</span> <span class='lt op'><</span> <span class='@rows ivar id'>@rows</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='size identifier id'>size</span> + <span class='offset identifier id'>offset</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='delete identifier id'>delete</span><span class='lparen token'>(</span><span class='symbol val'>:row_offset</span><span class='rparen token'>)</span> <span class='orop op'>||</span> <span class='integer val'>0</span> + <span class='@rows ivar id'>@rows</span><span class='lbrack token'>[</span><span class='lparen token'>(</span><span class='offset identifier id'>offset</span><span class='dot2 op'>..</span><span class='integer val'>-1</span><span class='rparen token'>)</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='r identifier id'>r</span><span class='bitor op'>|</span> <span class='r identifier id'>r</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='lbrack token'>[</span><span class='index identifier id'>index</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='style identifier id'>style</span> <span class='assign token'>=</span> <span class='style identifier id'>style</span> <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1280,13 +1683,15 @@ and all the other dirty details.</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>the recommended way to work with drawings and charts is Worksheet#add_chart</p> + <div class='inline'><p> +the recommended way to work with drawings and charts is Worksheet#add_chart +</p> </div> </div> - -<p>The drawing associated with this worksheet.</p> +<p> +The drawing associated with this worksheet. +</p> </div> @@ -1327,9 +1732,10 @@ and all the other dirty details.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 76</span> -<span class='kw'>def</span> <span class='id drawing'>drawing</span> - <span class='ivar'>@drawing</span> <span class='op'>||</span> <span class='ivar'>@drawing</span> <span class='op'>=</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Drawing</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='drawing identifier id'>drawing</span> + <span class='@drawing ivar id'>@drawing</span> <span class='orop op'>||</span> <span class='@drawing ivar id'>@drawing</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Drawing constant id'>Drawing</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1344,8 +1750,9 @@ and all the other dirty details.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The index of this worksheet in the owning Workbook's worksheets list.</p> + <p> +The index of this worksheet in the owning Workbook’s worksheets list. +</p> </div> @@ -1379,9 +1786,10 @@ and all the other dirty details.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 68</span> -<span class='kw'>def</span> <span class='id index'>index</span> - <span class='ivar'>@workbook</span><span class='period'>.</span><span class='id worksheets'>worksheets</span><span class='period'>.</span><span class='id index'>index</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='index identifier id'>index</span> + <span class='@workbook ivar id'>@workbook</span><span class='dot token'>.</span><span class='worksheets identifier id'>worksheets</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1396,8 +1804,9 @@ and all the other dirty details.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The part name of this worksheet</p> + <p> +The part name of this worksheet +</p> </div> @@ -1431,9 +1840,10 @@ and all the other dirty details.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 50</span> -<span class='kw'>def</span> <span class='id pn'>pn</span> - <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'>WORKSHEET_PN</span> <span class='op'>%</span> <span class='lparen'>(</span><span class='id index'>index</span><span class='op'>+</span><span class='int'>1</span><span class='rparen'>)</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='pn identifier id'>pn</span> + <span class='dstring node'>"#{WORKSHEET_PN % (index+1)}"</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1448,8 +1858,9 @@ and all the other dirty details.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The worksheet relationships. This is managed automatically by the worksheet</p> + <p> +The worksheet relationships. This is managed automatically by the worksheet +</p> </div> @@ -1476,20 +1887,21 @@ and all the other dirty details.</p> <pre class="lines"> -146 -147 -148 -149 -150</pre> +173 +174 +175 +176 +177</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 146</span> - -<span class='kw'>def</span> <span class='id relationships'>relationships</span> - <span class='id r'>r</span> <span class='op'>=</span> <span class='const'>Relationships</span><span class='period'>.</span><span class='id new'>new</span> - <span class='id r'>r</span> <span class='op'><<</span> <span class='const'>Relationship</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='const'>DRAWING_R</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>../</span><span class='embexpr_beg'>#{</span><span class='ivar'>@drawing</span><span class='period'>.</span><span class='id pn'>pn</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='ivar'>@drawing</span> - <span class='id r'>r</span> -<span class='kw'>end</span></pre> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 173</span> + +<span class='def def kw'>def</span> <span class='relationships identifier id'>relationships</span> + <span class='r identifier id'>r</span> <span class='assign token'>=</span> <span class='Relationships constant id'>Relationships</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='r identifier id'>r</span> <span class='lshft op'><<</span> <span class='Relationship constant id'>Relationship</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='DRAWING_R constant id'>DRAWING_R</span><span class='comma token'>,</span> <span class='dstring node'>"../#{@drawing.pn}"</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='@drawing ivar id'>@drawing</span> + <span class='r identifier id'>r</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1504,8 +1916,9 @@ and all the other dirty details.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The relationship part name of this worksheet</p> + <p> +The relationship part name of this worksheet +</p> </div> @@ -1539,9 +1952,10 @@ and all the other dirty details.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 56</span> -<span class='kw'>def</span> <span class='id rels_pn'>rels_pn</span> - <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'>WORKSHEET_RELS_PN</span> <span class='op'>%</span> <span class='lparen'>(</span><span class='id index'>index</span><span class='op'>+</span><span class='int'>1</span><span class='rparen'>)</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='rels_pn identifier id'>rels_pn</span> + <span class='dstring node'>"#{WORKSHEET_RELS_PN % (index+1)}"</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1556,8 +1970,9 @@ and all the other dirty details.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The relationship Id of thiw worksheet</p> + <p> +The relationship Id of thiw worksheet +</p> </div> @@ -1591,9 +2006,168 @@ and all the other dirty details.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 62</span> -<span class='kw'>def</span> <span class='id rId'>rId</span> - <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>rId</span><span class='embexpr_beg'>#{</span><span class='id index'>index</span><span class='op'>+</span><span class='int'>1</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='rId identifier id'>rId</span> + <span class='dstring node'>"rId#{index+1}"</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="row_style-instance_method"> + + - (<tt>Object</tt>) <strong>row_style</strong>(index, style, options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +You can also specify the style in the add_row call +</p> +</div> + </div> + +<p> +Set the style for cells in a specific row +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>index</span> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +the index of the row +</p> +</div> + + </li> + + <li> + + <span class='name'>the</span> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +cellXfs index +</p> +</div> + + </li> + + <li> + + <span class='name'>options</span> + + + <span class='type'>(<tt>Hash</tt>)</span> + + + <em class="default">(defaults to: <tt>{}</tt>)</em> + + + — + <div class='inline'><p> +a customizable set of options +</p> +</div> + + </li> + +</ul> + + + + + + + + + <h3>Options Hash (<tt>options</tt>):</h3> + <ul class="option"> + + <li> + <span class="name">col_offset</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + — <div class='inline'><p> +only cells after this column will be updated. +</p> +</div> + </li> + + </ul> + + +<h3>Raises:</h3> +<ul class="raise"> + + <li> + + + <span class='type'>(<tt>ArgumentError</tt>)</span> + + + + </li> + +</ul> + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="#add_row-instance_method" title="Axlsx::Worksheet#add_row (method)">#add_row</a></span></li> + + <li>for an example</li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +99 +100 +101 +102 +103</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 99</span> + +<span class='def def kw'>def</span> <span class='row_style identifier id'>row_style</span><span class='lparen token'>(</span><span class='index identifier id'>index</span><span class='comma token'>,</span> <span class='style identifier id'>style</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='string val'>"Invalid Row Index"</span> <span class='unless unless_mod kw'>unless</span> <span class='index identifier id'>index</span> <span class='lt op'><</span> <span class='@rows ivar id'>@rows</span><span class='dot token'>.</span><span class='size identifier id'>size</span> + <span class='offset identifier id'>offset</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='delete identifier id'>delete</span><span class='lparen token'>(</span><span class='symbol val'>:col_offset</span><span class='rparen token'>)</span> <span class='orop op'>||</span> <span class='integer val'>0</span> + <span class='@rows ivar id'>@rows</span><span class='lbrack token'>[</span><span class='index identifier id'>index</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='lbrack token'>[</span><span class='lparen token'>(</span><span class='offset identifier id'>offset</span><span class='dot2 op'>..</span><span class='integer val'>-1</span><span class='rparen token'>)</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='c identifier id'>c</span><span class='bitor op'>|</span> <span class='c identifier id'>c</span><span class='dot token'>.</span><span class='style identifier id'>style</span> <span class='assign token'>=</span> <span class='style identifier id'>style</span> <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1608,8 +2182,9 @@ and all the other dirty details.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the worksheet document</p> + <p> +Serializes the worksheet document +</p> </div> @@ -1636,52 +2211,168 @@ and all the other dirty details.</p> <pre class="lines"> -122 -123 -124 -125 -126 -127 -128 -129 -130 -131 -132 -133 -134 -135 -136 -137 -138 -139 -140 -141 -142</pre> +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 149</span> + +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span> + <span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='worksheet identifier id'>worksheet</span><span class='lparen token'>(</span><span class='symbol val'>:xmlns</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS constant id'>XML_NS</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:r'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS_R constant id'>XML_NS_R</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='if if kw'>if</span> <span class='@auto_fit_data ivar id'>@auto_fit_data</span><span class='dot token'>.</span><span class='size identifier id'>size</span> <span class='gt op'>></span> <span class='integer val'>0</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='cols identifier id'>cols</span> <span class='lbrace token'>{</span> + <span class='@auto_fit_data ivar id'>@auto_fit_data</span><span class='dot token'>.</span><span class='each_with_index identifier id'>each_with_index</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='col identifier id'>col</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span> + <span class='min_max identifier id'>min_max</span> <span class='assign token'>=</span> <span class='index identifier id'>index</span><span class='plus op'>+</span><span class='integer val'>1</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='col identifier id'>col</span><span class='lparen token'>(</span><span class='symbol val'>:min=</span><span class='gt op'>></span><span class='min_max identifier id'>min_max</span><span class='comma token'>,</span> <span class='symbol val'>:max=</span><span class='gt op'>></span><span class='min_max identifier id'>min_max</span><span class='comma token'>,</span> <span class='symbol val'>:width</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='auto_width identifier id'>auto_width</span><span class='lparen token'>(</span><span class='col identifier id'>col</span><span class='rparen token'>)</span><span class='comma token'>,</span> <span class='symbol val'>:customWidth=</span><span class='gt op'>></span><span class='string val'>"true"</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='sheetData identifier id'>sheetData</span> <span class='lbrace token'>{</span> + <span class='@rows ivar id'>@rows</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='row identifier id'>row</span><span class='bitor op'>|</span> + <span class='row identifier id'>row</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> + <span class='rbrace token'>}</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='drawing identifier id'>drawing</span> <span class='symbol val'>:"r:id"</span><span class='assign token'>=</span><span class='gt op'>></span><span class='string val'>"rId1"</span> <span class='if if_mod kw'>if</span> <span class='@drawing ivar id'>@drawing</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="update_auto_fit_data-instance_method"> + + - (<tt>Array</tt>) <strong>update_auto_fit_data</strong>(cells) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Updates auto fit data. Autofit data attempts to determine the cell in a +column that has the greatest width by comparing the length of the text +multiplied by the size of the font. +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>cells</span> + + + <span class='type'>(<tt>Array</tt>)</span> + + + + — + <div class='inline'><p> +an array of cells +</p> +</div> + + </li> + +</ul> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Array</tt>)</span> + + + + — + <div class='inline'><p> +of Cell objects +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +188 +189 +190 +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 122</span> - -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span> - <span class='id builder'>builder</span> <span class='op'>=</span> <span class='const'>Nokogiri</span><span class='op'>::</span><span class='const'>XML</span><span class='op'>::</span><span class='const'>Builder</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='symbol'>:encoding</span> <span class='op'>=></span> <span class='const'>ENCODING</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id xml'>xml</span><span class='op'>|</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id worksheet'>worksheet</span><span class='lparen'>(</span><span class='symbol'>:xmlns</span> <span class='op'>=></span> <span class='const'>XML_NS</span><span class='comma'>,</span> <span class='symbol'>:xmlns:r</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='const'>XML_NS_R</span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='kw'>if</span> <span class='ivar'>@auto_fit_data</span><span class='period'>.</span><span class='id size'>size</span> <span class='op'>></span> <span class='int'>0</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id cols'>cols</span> <span class='lbrace'>{</span> - <span class='ivar'>@auto_fit_data</span><span class='period'>.</span><span class='id each_with_index'>each_with_index</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id col'>col</span><span class='comma'>,</span> <span class='id index'>index</span><span class='op'>|</span> - <span class='id min_max'>min_max</span> <span class='op'>=</span> <span class='id index'>index</span><span class='op'>+</span><span class='int'>1</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id col'>col</span><span class='lparen'>(</span><span class='symbol'>:min</span><span class='op'>=></span><span class='id min_max'>min_max</span><span class='comma'>,</span> <span class='symbol'>:max</span><span class='op'>=></span><span class='id min_max'>min_max</span><span class='comma'>,</span> <span class='symbol'>:width</span> <span class='op'>=></span> <span class='id auto_width'>auto_width</span><span class='lparen'>(</span><span class='id col'>col</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='symbol'>:customWidth</span><span class='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>true</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> - <span class='kw'>end</span> - <span class='rbrace'>}</span> - <span class='kw'>end</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id sheetData'>sheetData</span> <span class='lbrace'>{</span> - <span class='ivar'>@rows</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id row'>row</span><span class='op'>|</span> - <span class='id row'>row</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='kw'>end</span> - <span class='rbrace'>}</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id drawing'>drawing</span> <span class='symbol'>:r:id</span><span class='tstring_end'>"</span></span><span class='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>rId1</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='ivar'>@drawing</span> - <span class='rbrace'>}</span> - <span class='kw'>end</span> - <span class='id builder'>builder</span><span class='period'>.</span><span class='id to_xml'>to_xml</span> -<span class='kw'>end</span></pre> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 188</span> + +<span class='def def kw'>def</span> <span class='update_auto_fit_data identifier id'>update_auto_fit_data</span><span class='lparen token'>(</span><span class='cells identifier id'>cells</span><span class='rparen token'>)</span> + <span class='styles identifier id'>styles</span> <span class='assign token'>=</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span> + <span class='cellXfs identifier id'>cellXfs</span><span class='comma token'>,</span> <span class='fonts identifier id'>fonts</span> <span class='assign token'>=</span> <span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='cellXfs identifier id'>cellXfs</span><span class='comma token'>,</span> <span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='fonts identifier id'>fonts</span> + <span class='sz identifier id'>sz</span> <span class='assign token'>=</span> <span class='fonts identifier id'>fonts</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='sz identifier id'>sz</span> + + <span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='each_with_index identifier id'>each_with_index</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='item identifier id'>item</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span> + <span class='col identifier id'>col</span> <span class='assign token'>=</span> <span class='@auto_fit_data ivar id'>@auto_fit_data</span><span class='lbrack token'>[</span><span class='index identifier id'>index</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='lbrace token'>{</span><span class='symbol val'>:longest=</span><span class='gt op'>></span><span class='string val'>""</span><span class='comma token'>,</span> <span class='symbol val'>:sz=</span><span class='gt op'>></span><span class='sz identifier id'>sz</span><span class='rbrace token'>}</span> + <span class='cell_xf identifier id'>cell_xf</span> <span class='assign token'>=</span> <span class='cellXfs identifier id'>cellXfs</span><span class='lbrack token'>[</span><span class='item identifier id'>item</span><span class='dot token'>.</span><span class='style identifier id'>style</span><span class='rbrack token'>]</span> + <span class='font identifier id'>font</span> <span class='assign token'>=</span> <span class='fonts identifier id'>fonts</span><span class='lbrack token'>[</span><span class='cell_xf identifier id'>cell_xf</span><span class='dot token'>.</span><span class='fontId identifier id'>fontId</span> <span class='orop op'>||</span> <span class='integer val'>0</span><span class='rbrack token'>]</span> + <span class='sz identifier id'>sz</span> <span class='assign token'>=</span> <span class='font identifier id'>font</span><span class='dot token'>.</span><span class='sz identifier id'>sz</span> <span class='orop op'>||</span> <span class='sz identifier id'>sz</span> + + <span class='if if kw'>if</span> <span class='lparen token'>(</span><span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:longest</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='scan identifier id'>scan</span><span class='lparen token'>(</span><span class='regexp val'>/./</span><span class='mu identifier id'>mu</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='size identifier id'>size</span> <span class='mult op'>*</span> <span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:sz</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='lt op'><</span> <span class='lparen token'>(</span><span class='item identifier id'>item</span><span class='dot token'>.</span><span class='value identifier id'>value</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='dot token'>.</span><span class='scan identifier id'>scan</span><span class='lparen token'>(</span><span class='regexp val'>/./</span><span class='mu identifier id'>mu</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='size identifier id'>size</span> <span class='mult op'>*</span> <span class='sz identifier id'>sz</span><span class='rparen token'>)</span> + <span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:sz</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='sz identifier id'>sz</span> + <span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:longest</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='item identifier id'>item</span><span class='dot token'>.</span><span class='value identifier id'>value</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span> + <span class='end end kw'>end</span> + <span class='@auto_fit_data ivar id'>@auto_fit_data</span><span class='lbrack token'>[</span><span class='index identifier id'>index</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='col identifier id'>col</span> + <span class='end end kw'>end</span> + <span class='cells identifier id'>cells</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1692,9 +2383,9 @@ and all the other dirty details.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:40 2011 by + Generated on Sun Nov 27 18:05:04 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/Axlsx/Xf.html b/doc/Axlsx/Xf.html index b42932ab..79e3b590 100644 --- a/doc/Axlsx/Xf.html +++ b/doc/Axlsx/Xf.html @@ -94,9 +94,10 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>The Xf class defines a formatting record for use in Styles. The recommended -way to manage styles for your workbook is with Styles#add_style</p> + <p> +The Xf class defines a formatting record for use in Styles. The recommended +way to manage styles for your workbook is with Styles#add_style +</p> </div> @@ -135,8 +136,9 @@ way to manage styles for your workbook is with Styles#add_style</p> - <span class="summary_desc"><div class='inline'> -<p>The cell alignment for this style.</p> + <span class="summary_desc"><div class='inline'><p> +The cell alignment for this style. +</p> </div></span> </li> @@ -161,8 +163,9 @@ way to manage styles for your workbook is with Styles#add_style</p> - <span class="summary_desc"><div class='inline'> -<p>Indicates if the alignment options should be applied.</p> + <span class="summary_desc"><div class='inline'><p> +Indicates if the alignment options should be applied. +</p> </div></span> </li> @@ -187,8 +190,9 @@ way to manage styles for your workbook is with Styles#add_style</p> - <span class="summary_desc"><div class='inline'> -<p>indicates if the borderId should be applied.</p> + <span class="summary_desc"><div class='inline'><p> +indicates if the borderId should be applied. +</p> </div></span> </li> @@ -213,8 +217,9 @@ way to manage styles for your workbook is with Styles#add_style</p> - <span class="summary_desc"><div class='inline'> -<p>indicates if the fillId should be applied.</p> + <span class="summary_desc"><div class='inline'><p> +indicates if the fillId should be applied. +</p> </div></span> </li> @@ -239,8 +244,9 @@ way to manage styles for your workbook is with Styles#add_style</p> - <span class="summary_desc"><div class='inline'> -<p>indicates if the fontId should be applied.</p> + <span class="summary_desc"><div class='inline'><p> +indicates if the fontId should be applied. +</p> </div></span> </li> @@ -265,8 +271,9 @@ way to manage styles for your workbook is with Styles#add_style</p> - <span class="summary_desc"><div class='inline'> -<p>indicates if the numFmtId should be applied.</p> + <span class="summary_desc"><div class='inline'><p> +indicates if the numFmtId should be applied. +</p> </div></span> </li> @@ -291,8 +298,9 @@ way to manage styles for your workbook is with Styles#add_style</p> - <span class="summary_desc"><div class='inline'> -<p>Indicates if the protection options should be applied.</p> + <span class="summary_desc"><div class='inline'><p> +Indicates if the protection options should be applied. +</p> </div></span> </li> @@ -317,8 +325,9 @@ way to manage styles for your workbook is with Styles#add_style</p> - <span class="summary_desc"><div class='inline'> -<p>index (0 based) of the border to be used in this style.</p> + <span class="summary_desc"><div class='inline'><p> +index (0 based) of the border to be used in this style. +</p> </div></span> </li> @@ -343,8 +352,9 @@ way to manage styles for your workbook is with Styles#add_style</p> - <span class="summary_desc"><div class='inline'> -<p>index (0 based) of the fill to be used in this style.</p> + <span class="summary_desc"><div class='inline'><p> +index (0 based) of the fill to be used in this style. +</p> </div></span> </li> @@ -369,8 +379,9 @@ way to manage styles for your workbook is with Styles#add_style</p> - <span class="summary_desc"><div class='inline'> -<p>index (0 based) of the font to be used in this style.</p> + <span class="summary_desc"><div class='inline'><p> +index (0 based) of the font to be used in this style. +</p> </div></span> </li> @@ -395,8 +406,9 @@ way to manage styles for your workbook is with Styles#add_style</p> - <span class="summary_desc"><div class='inline'> -<p>id of the numFmt to apply to this style.</p> + <span class="summary_desc"><div class='inline'><p> +id of the numFmt to apply to this style. +</p> </div></span> </li> @@ -421,8 +433,9 @@ way to manage styles for your workbook is with Styles#add_style</p> - <span class="summary_desc"><div class='inline'> -<p>indicates if the cell has a pivot table drop down button.</p> + <span class="summary_desc"><div class='inline'><p> +indicates if the cell has a pivot table drop down button. +</p> </div></span> </li> @@ -447,8 +460,9 @@ way to manage styles for your workbook is with Styles#add_style</p> - <span class="summary_desc"><div class='inline'> -<p>The cell protection for this style.</p> + <span class="summary_desc"><div class='inline'><p> +The cell protection for this style. +</p> </div></span> </li> @@ -473,8 +487,9 @@ way to manage styles for your workbook is with Styles#add_style</p> - <span class="summary_desc"><div class='inline'> -<p>indecates if text should be prefixed by a single quote in the cell.</p> + <span class="summary_desc"><div class='inline'><p> +indecates if text should be prefixed by a single quote in the cell. +</p> </div></span> </li> @@ -499,8 +514,9 @@ way to manage styles for your workbook is with Styles#add_style</p> - <span class="summary_desc"><div class='inline'> -<p>index (0 based) of cellStylesXfs item to be used in this style.</p> + <span class="summary_desc"><div class='inline'><p> +index (0 based) of cellStylesXfs item to be used in this style. +</p> </div></span> </li> @@ -537,8 +553,9 @@ way to manage styles for your workbook is with Styles#add_style</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a new Xf object.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new Xf object. +</p> </div></span> </li> @@ -560,8 +577,9 @@ way to manage styles for your workbook is with Styles#add_style</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the xf elemen.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the xf elemen. +</p> </div></span> </li> @@ -582,8 +600,9 @@ way to manage styles for your workbook is with Styles#add_style</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new Xf object</p> + <p> +Creates a new Xf object +</p> </div> @@ -604,8 +623,9 @@ way to manage styles for your workbook is with Styles#add_style</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -772,11 +792,12 @@ way to manage styles for your workbook is with Styles#add_style</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 85</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span> - <span class='kw'>end</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -799,8 +820,9 @@ way to manage styles for your workbook is with Styles#add_style</p> </p><div class="docstring"> <div class="discussion"> - -<p>The cell alignment for this style</p> + <p> +The cell alignment for this style +</p> </div> @@ -841,9 +863,10 @@ way to manage styles for your workbook is with Styles#add_style</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 10</span> -<span class='kw'>def</span> <span class='id alignment'>alignment</span> - <span class='ivar'>@alignment</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='alignment identifier id'>alignment</span> + <span class='@alignment ivar id'>@alignment</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -861,8 +884,9 @@ way to manage styles for your workbook is with Styles#add_style</p> </p><div class="docstring"> <div class="discussion"> - -<p>Indicates if the alignment options should be applied</p> + <p> +Indicates if the alignment options should be applied +</p> </div> @@ -896,9 +920,10 @@ way to manage styles for your workbook is with Styles#add_style</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 63</span> -<span class='kw'>def</span> <span class='id applyAlignment'>applyAlignment</span> - <span class='ivar'>@applyAlignment</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='applyAlignment identifier id'>applyAlignment</span> + <span class='@applyAlignment ivar id'>@applyAlignment</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -916,8 +941,9 @@ way to manage styles for your workbook is with Styles#add_style</p> </p><div class="docstring"> <div class="discussion"> - -<p>indicates if the borderId should be applied</p> + <p> +indicates if the borderId should be applied +</p> </div> @@ -951,9 +977,10 @@ way to manage styles for your workbook is with Styles#add_style</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 59</span> -<span class='kw'>def</span> <span class='id applyBorder'>applyBorder</span> - <span class='ivar'>@applyBorder</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='applyBorder identifier id'>applyBorder</span> + <span class='@applyBorder ivar id'>@applyBorder</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -971,8 +998,9 @@ way to manage styles for your workbook is with Styles#add_style</p> </p><div class="docstring"> <div class="discussion"> - -<p>indicates if the fillId should be applied</p> + <p> +indicates if the fillId should be applied +</p> </div> @@ -1006,9 +1034,10 @@ way to manage styles for your workbook is with Styles#add_style</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 55</span> -<span class='kw'>def</span> <span class='id applyFill'>applyFill</span> - <span class='ivar'>@applyFill</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='applyFill identifier id'>applyFill</span> + <span class='@applyFill ivar id'>@applyFill</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1026,8 +1055,9 @@ way to manage styles for your workbook is with Styles#add_style</p> </p><div class="docstring"> <div class="discussion"> - -<p>indicates if the fontId should be applied</p> + <p> +indicates if the fontId should be applied +</p> </div> @@ -1061,9 +1091,10 @@ way to manage styles for your workbook is with Styles#add_style</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 51</span> -<span class='kw'>def</span> <span class='id applyFont'>applyFont</span> - <span class='ivar'>@applyFont</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='applyFont identifier id'>applyFont</span> + <span class='@applyFont ivar id'>@applyFont</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1081,8 +1112,9 @@ way to manage styles for your workbook is with Styles#add_style</p> </p><div class="docstring"> <div class="discussion"> - -<p>indicates if the numFmtId should be applied</p> + <p> +indicates if the numFmtId should be applied +</p> </div> @@ -1116,9 +1148,10 @@ way to manage styles for your workbook is with Styles#add_style</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 47</span> -<span class='kw'>def</span> <span class='id applyNumberFormat'>applyNumberFormat</span> - <span class='ivar'>@applyNumberFormat</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='applyNumberFormat identifier id'>applyNumberFormat</span> + <span class='@applyNumberFormat ivar id'>@applyNumberFormat</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1136,8 +1169,9 @@ way to manage styles for your workbook is with Styles#add_style</p> </p><div class="docstring"> <div class="discussion"> - -<p>Indicates if the protection options should be applied</p> + <p> +Indicates if the protection options should be applied +</p> </div> @@ -1171,9 +1205,10 @@ way to manage styles for your workbook is with Styles#add_style</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 67</span> -<span class='kw'>def</span> <span class='id applyProtection'>applyProtection</span> - <span class='ivar'>@applyProtection</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='applyProtection identifier id'>applyProtection</span> + <span class='@applyProtection ivar id'>@applyProtection</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1191,8 +1226,9 @@ way to manage styles for your workbook is with Styles#add_style</p> </p><div class="docstring"> <div class="discussion"> - -<p>index (0 based) of the border to be used in this style</p> + <p> +index (0 based) of the border to be used in this style +</p> </div> @@ -1226,9 +1262,10 @@ way to manage styles for your workbook is with Styles#add_style</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 31</span> -<span class='kw'>def</span> <span class='id borderId'>borderId</span> - <span class='ivar'>@borderId</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='borderId identifier id'>borderId</span> + <span class='@borderId ivar id'>@borderId</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1246,8 +1283,9 @@ way to manage styles for your workbook is with Styles#add_style</p> </p><div class="docstring"> <div class="discussion"> - -<p>index (0 based) of the fill to be used in this style</p> + <p> +index (0 based) of the fill to be used in this style +</p> </div> @@ -1281,9 +1319,10 @@ way to manage styles for your workbook is with Styles#add_style</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 27</span> -<span class='kw'>def</span> <span class='id fillId'>fillId</span> - <span class='ivar'>@fillId</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='fillId identifier id'>fillId</span> + <span class='@fillId ivar id'>@fillId</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1301,8 +1340,9 @@ way to manage styles for your workbook is with Styles#add_style</p> </p><div class="docstring"> <div class="discussion"> - -<p>index (0 based) of the font to be used in this style</p> + <p> +index (0 based) of the font to be used in this style +</p> </div> @@ -1336,9 +1376,10 @@ way to manage styles for your workbook is with Styles#add_style</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 23</span> -<span class='kw'>def</span> <span class='id fontId'>fontId</span> - <span class='ivar'>@fontId</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='fontId identifier id'>fontId</span> + <span class='@fontId ivar id'>@fontId</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1356,8 +1397,9 @@ way to manage styles for your workbook is with Styles#add_style</p> </p><div class="docstring"> <div class="discussion"> - -<p>id of the numFmt to apply to this style</p> + <p> +id of the numFmt to apply to this style +</p> </div> @@ -1391,9 +1433,10 @@ way to manage styles for your workbook is with Styles#add_style</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 19</span> -<span class='kw'>def</span> <span class='id numFmtId'>numFmtId</span> - <span class='ivar'>@numFmtId</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='numFmtId identifier id'>numFmtId</span> + <span class='@numFmtId ivar id'>@numFmtId</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1411,8 +1454,9 @@ way to manage styles for your workbook is with Styles#add_style</p> </p><div class="docstring"> <div class="discussion"> - -<p>indicates if the cell has a pivot table drop down button</p> + <p> +indicates if the cell has a pivot table drop down button +</p> </div> @@ -1446,9 +1490,10 @@ way to manage styles for your workbook is with Styles#add_style</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 43</span> -<span class='kw'>def</span> <span class='id pivotButton'>pivotButton</span> - <span class='ivar'>@pivotButton</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='pivotButton identifier id'>pivotButton</span> + <span class='@pivotButton ivar id'>@pivotButton</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1466,8 +1511,9 @@ way to manage styles for your workbook is with Styles#add_style</p> </p><div class="docstring"> <div class="discussion"> - -<p>The cell protection for this style</p> + <p> +The cell protection for this style +</p> </div> @@ -1508,9 +1554,10 @@ way to manage styles for your workbook is with Styles#add_style</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 15</span> -<span class='kw'>def</span> <span class='id protection'>protection</span> - <span class='ivar'>@protection</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='protection identifier id'>protection</span> + <span class='@protection ivar id'>@protection</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1528,8 +1575,9 @@ way to manage styles for your workbook is with Styles#add_style</p> </p><div class="docstring"> <div class="discussion"> - -<p>indecates if text should be prefixed by a single quote in the cell</p> + <p> +indecates if text should be prefixed by a single quote in the cell +</p> </div> @@ -1563,9 +1611,10 @@ way to manage styles for your workbook is with Styles#add_style</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 39</span> -<span class='kw'>def</span> <span class='id quotePrefix'>quotePrefix</span> - <span class='ivar'>@quotePrefix</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='quotePrefix identifier id'>quotePrefix</span> + <span class='@quotePrefix ivar id'>@quotePrefix</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1583,9 +1632,10 @@ way to manage styles for your workbook is with Styles#add_style</p> </p><div class="docstring"> <div class="discussion"> - -<p>index (0 based) of cellStylesXfs item to be used in this style. Only -applies to cellXfs items</p> + <p> +index (0 based) of cellStylesXfs item to be used in this style. Only +applies to cellXfs items +</p> </div> @@ -1619,9 +1669,10 @@ applies to cellXfs items</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 35</span> -<span class='kw'>def</span> <span class='id xfId'>xfId</span> - <span class='ivar'>@xfId</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='xfId identifier id'>xfId</span> + <span class='@xfId ivar id'>@xfId</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1643,8 +1694,9 @@ applies to cellXfs items</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the xf elemen</p> + <p> +Serializes the xf elemen +</p> </div> @@ -1663,8 +1715,9 @@ applies to cellXfs items</p> — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -1701,12 +1754,13 @@ applies to cellXfs items</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 131</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id xf'>xf</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id instance_values'>instance_values</span><span class='period'>.</span><span class='id reject'>reject</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id k'>k</span><span class='comma'>,</span> <span class='id v'>v</span><span class='op'>|</span> <span class='lbracket'>[</span><span class='symbol'>:alignment</span><span class='comma'>,</span> <span class='symbol'>:protection</span><span class='comma'>,</span> <span class='symbol'>:extList</span><span class='comma'>,</span> <span class='symbol'>:name</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id include?'>include?</span> <span class='id k'>k</span><span class='period'>.</span><span class='id to_sym'>to_sym</span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id alignment'>alignment</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id alignment'>alignment</span> - <span class='id protection'>protection</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id protection'>protection</span> - <span class='rbrace'>}</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='xf identifier id'>xf</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='dot token'>.</span><span class='reject identifier id'>reject</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='k identifier id'>k</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='bitor op'>|</span> <span class='lbrack token'>[</span><span class='symbol val'>:alignment</span><span class='comma token'>,</span> <span class='symbol val'>:protection</span><span class='comma token'>,</span> <span class='symbol val'>:extList</span><span class='comma token'>,</span> <span class='symbol val'>:name</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='include? fid id'>include?</span> <span class='k identifier id'>k</span><span class='dot token'>.</span><span class='to_sym identifier id'>to_sym</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='alignment identifier id'>alignment</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='alignment identifier id'>alignment</span> + <span class='protection identifier id'>protection</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='protection identifier id'>protection</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1717,9 +1771,9 @@ applies to cellXfs items</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:37 2011 by + Generated on Sun Nov 27 18:05:08 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/_index.html b/doc/_index.html index 06787029..ad0fc86c 100644 --- a/doc/_index.html +++ b/doc/_index.html @@ -91,6 +91,13 @@ </li> <li> + <span class='object_link'><a href="Axlsx/Ar.html" title="Axlsx::Ar (module)">Ar</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> <span class='object_link'><a href="Axlsx/Axis.html" title="Axlsx::Axis (class)">Axis</a></span> <small>(Axlsx)</small> @@ -196,6 +203,13 @@ </li> <li> + <span class='object_link'><a href="Axlsx/Ar/ClassMethods.html" title="Axlsx::Ar::ClassMethods (module)">ClassMethods</a></span> + + <small>(Axlsx::Ar)</small> + + </li> + + <li> <span class='object_link'><a href="Axlsx/Color.html" title="Axlsx::Color (class)">Color</a></span> <small>(Axlsx)</small> @@ -300,6 +314,24 @@ </ul> + <ul id="alpha_I" class="alpha"> + <li class="letter">I</li> + <ul> + + <li> + <span class='object_link'><a href="Axlsx/Ar/InstanceMethods.html" title="Axlsx::Ar::InstanceMethods (module)">InstanceMethods</a></span> + + <small>(Axlsx::Ar)</small> + + </li> + + </ul> + </ul> + + + </td><td valign='top' width="33%"> + + <ul id="alpha_L" class="alpha"> <li class="letter">L</li> <ul> @@ -322,9 +354,6 @@ </ul> - </td><td valign='top' width="33%"> - - <ul id="alpha_M" class="alpha"> <li class="letter">M</li> <ul> @@ -496,6 +525,13 @@ </li> <li> + <span class='object_link'><a href="Axlsx/Ar/SingletonMethods.html" title="Axlsx::Ar::SingletonMethods (module)">SingletonMethods</a></span> + + <small>(Axlsx::Ar)</small> + + </li> + + <li> <span class='object_link'><a href="Axlsx/Styles.html" title="Axlsx::Styles (class)">Styles</a></span> <small>(Axlsx)</small> @@ -549,6 +585,9 @@ </ul> + </td><td valign='top' width="33%"> + + <ul id="alpha_V" class="alpha"> <li class="letter">V</li> <ul> @@ -578,9 +617,6 @@ </ul> - </td><td valign='top' width="33%"> - - <ul id="alpha_W" class="alpha"> <li class="letter">W</li> <ul> @@ -626,9 +662,9 @@ </div> <div id="footer"> - Generated on Sat Nov 26 13:16:35 2011 by + Generated on Sun Nov 27 18:05:01 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/class_list.html b/doc/class_list.html index 2d555b04..17e81b3c 100644 --- a/doc/class_list.html +++ b/doc/class_list.html @@ -39,7 +39,7 @@ <ul id="full_list" class="class"> <li><span class='object_link'><a href="top-level-namespace.html" title=" (root)">Top Level Namespace</a></span></li> -<li><a class='toggle'></a> <span class='object_link'><a href="Axlsx.html" title="Axlsx (module)">Axlsx</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><span class='object_link'><a href="Axlsx/App.html" title="Axlsx::App (class)">App</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Axis.html" title="Axlsx::Axis (class)">Axis</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Bar3DChart.html" title="Axlsx::Bar3DChart (class)">Bar3DChart</a></span> < Chart<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/BarSeries.html" title="Axlsx::BarSeries (class)">BarSeries</a></span> < Series<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Border.html" title="Axlsx::Border (class)">Border</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/BorderPr.html" title="Axlsx::BorderPr (class)">BorderPr</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/CatAxis.html" title="Axlsx::CatAxis (class)">CatAxis</a></span> < Axis<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/CatAxisData.html" title="Axlsx::CatAxisData (class)">CatAxisData</a></span> < SimpleTypedList<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Cell.html" title="Axlsx::Cell (class)">Cell</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/CellAlignment.html" title="Axlsx::CellAlignment (class)">CellAlignment</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/CellProtection.html" title="Axlsx::CellProtection (class)">CellProtection</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/CellStyle.html" title="Axlsx::CellStyle (class)">CellStyle</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Chart.html" title="Axlsx::Chart (class)">Chart</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Color.html" title="Axlsx::Color (class)">Color</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/ContentType.html" title="Axlsx::ContentType (class)">ContentType</a></span> < SimpleTypedList<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Core.html" title="Axlsx::Core (class)">Core</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/DataTypeValidator.html" title="Axlsx::DataTypeValidator (class)">DataTypeValidator</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Default.html" title="Axlsx::Default (class)">Default</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Drawing.html" title="Axlsx::Drawing (class)">Drawing</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Fill.html" title="Axlsx::Fill (class)">Fill</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Font.html" title="Axlsx::Font (class)">Font</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/GradientFill.html" title="Axlsx::GradientFill (class)">GradientFill</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/GradientStop.html" title="Axlsx::GradientStop (class)">GradientStop</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/GraphicFrame.html" title="Axlsx::GraphicFrame (class)">GraphicFrame</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Line3DChart.html" title="Axlsx::Line3DChart (class)">Line3DChart</a></span> < Chart<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/LineSeries.html" title="Axlsx::LineSeries (class)">LineSeries</a></span> < Series<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Marker.html" title="Axlsx::Marker (class)">Marker</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/NumFmt.html" title="Axlsx::NumFmt (class)">NumFmt</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/OneCellAnchor.html" title="Axlsx::OneCellAnchor (class)">OneCellAnchor</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Override.html" title="Axlsx::Override (class)">Override</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Package.html" title="Axlsx::Package (class)">Package</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/PatternFill.html" title="Axlsx::PatternFill (class)">PatternFill</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Pic.html" title="Axlsx::Pic (class)">Pic</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Pie3DChart.html" title="Axlsx::Pie3DChart (class)">Pie3DChart</a></span> < Chart<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/PieSeries.html" title="Axlsx::PieSeries (class)">PieSeries</a></span> < Series<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/RegexValidator.html" title="Axlsx::RegexValidator (class)">RegexValidator</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Relationship.html" title="Axlsx::Relationship (class)">Relationship</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span> < SimpleTypedList<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/RestrictionValidator.html" title="Axlsx::RestrictionValidator (class)">RestrictionValidator</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Row.html" title="Axlsx::Row (class)">Row</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Scaling.html" title="Axlsx::Scaling (class)">Scaling</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/SerAxis.html" title="Axlsx::SerAxis (class)">SerAxis</a></span> < Axis<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Series.html" title="Axlsx::Series (class)">Series</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/SeriesTitle.html" title="Axlsx::SeriesTitle (class)">SeriesTitle</a></span> < Title<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Styles.html" title="Axlsx::Styles (class)">Styles</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/TableStyle.html" title="Axlsx::TableStyle (class)">TableStyle</a></span> < SimpleTypedList<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/TableStyleElement.html" title="Axlsx::TableStyleElement (class)">TableStyleElement</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/TableStyles.html" title="Axlsx::TableStyles (class)">TableStyles</a></span> < SimpleTypedList<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Title.html" title="Axlsx::Title (class)">Title</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/TwoCellAnchor.html" title="Axlsx::TwoCellAnchor (class)">TwoCellAnchor</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/ValAxis.html" title="Axlsx::ValAxis (class)">ValAxis</a></span> < Axis<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/ValAxisData.html" title="Axlsx::ValAxisData (class)">ValAxisData</a></span> < CatAxisData<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/View3D.html" title="Axlsx::View3D (class)">View3D</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Xf.html" title="Axlsx::Xf (class)">Xf</a></span> < Object<small class='search_info'>Axlsx</small></li></ul> +<li><a class='toggle'></a> <span class='object_link'><a href="Axlsx.html" title="Axlsx (module)">Axlsx</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><span class='object_link'><a href="Axlsx/App.html" title="Axlsx::App (class)">App</a></span> < Object<small class='search_info'>Axlsx</small></li><li><a class='toggle'></a> <span class='object_link'><a href="Axlsx/Ar.html" title="Axlsx::Ar (module)">Ar</a></span><small class='search_info'>Axlsx</small></li><ul><li><span class='object_link'><a href="Axlsx/Ar/ClassMethods.html" title="Axlsx::Ar::ClassMethods (module)">ClassMethods</a></span><small class='search_info'>Axlsx::Ar</small></li><li><span class='object_link'><a href="Axlsx/Ar/InstanceMethods.html" title="Axlsx::Ar::InstanceMethods (module)">InstanceMethods</a></span><small class='search_info'>Axlsx::Ar</small></li><li><span class='object_link'><a href="Axlsx/Ar/SingletonMethods.html" title="Axlsx::Ar::SingletonMethods (module)">SingletonMethods</a></span><small class='search_info'>Axlsx::Ar</small></li></ul><li><span class='object_link'><a href="Axlsx/Axis.html" title="Axlsx::Axis (class)">Axis</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Bar3DChart.html" title="Axlsx::Bar3DChart (class)">Bar3DChart</a></span> < Chart<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/BarSeries.html" title="Axlsx::BarSeries (class)">BarSeries</a></span> < Series<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Border.html" title="Axlsx::Border (class)">Border</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/BorderPr.html" title="Axlsx::BorderPr (class)">BorderPr</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/CatAxis.html" title="Axlsx::CatAxis (class)">CatAxis</a></span> < Axis<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/CatAxisData.html" title="Axlsx::CatAxisData (class)">CatAxisData</a></span> < SimpleTypedList<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Cell.html" title="Axlsx::Cell (class)">Cell</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/CellAlignment.html" title="Axlsx::CellAlignment (class)">CellAlignment</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/CellProtection.html" title="Axlsx::CellProtection (class)">CellProtection</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/CellStyle.html" title="Axlsx::CellStyle (class)">CellStyle</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Chart.html" title="Axlsx::Chart (class)">Chart</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Color.html" title="Axlsx::Color (class)">Color</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/ContentType.html" title="Axlsx::ContentType (class)">ContentType</a></span> < SimpleTypedList<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Core.html" title="Axlsx::Core (class)">Core</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/DataTypeValidator.html" title="Axlsx::DataTypeValidator (class)">DataTypeValidator</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Default.html" title="Axlsx::Default (class)">Default</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Drawing.html" title="Axlsx::Drawing (class)">Drawing</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Fill.html" title="Axlsx::Fill (class)">Fill</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Font.html" title="Axlsx::Font (class)">Font</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/GradientFill.html" title="Axlsx::GradientFill (class)">GradientFill</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/GradientStop.html" title="Axlsx::GradientStop (class)">GradientStop</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/GraphicFrame.html" title="Axlsx::GraphicFrame (class)">GraphicFrame</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Line3DChart.html" title="Axlsx::Line3DChart (class)">Line3DChart</a></span> < Chart<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/LineSeries.html" title="Axlsx::LineSeries (class)">LineSeries</a></span> < Series<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Marker.html" title="Axlsx::Marker (class)">Marker</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/NumFmt.html" title="Axlsx::NumFmt (class)">NumFmt</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/OneCellAnchor.html" title="Axlsx::OneCellAnchor (class)">OneCellAnchor</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Override.html" title="Axlsx::Override (class)">Override</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Package.html" title="Axlsx::Package (class)">Package</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/PatternFill.html" title="Axlsx::PatternFill (class)">PatternFill</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Pic.html" title="Axlsx::Pic (class)">Pic</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Pie3DChart.html" title="Axlsx::Pie3DChart (class)">Pie3DChart</a></span> < Chart<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/PieSeries.html" title="Axlsx::PieSeries (class)">PieSeries</a></span> < Series<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/RegexValidator.html" title="Axlsx::RegexValidator (class)">RegexValidator</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Relationship.html" title="Axlsx::Relationship (class)">Relationship</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span> < SimpleTypedList<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/RestrictionValidator.html" title="Axlsx::RestrictionValidator (class)">RestrictionValidator</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Row.html" title="Axlsx::Row (class)">Row</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Scaling.html" title="Axlsx::Scaling (class)">Scaling</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/SerAxis.html" title="Axlsx::SerAxis (class)">SerAxis</a></span> < Axis<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Series.html" title="Axlsx::Series (class)">Series</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/SeriesTitle.html" title="Axlsx::SeriesTitle (class)">SeriesTitle</a></span> < Title<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Styles.html" title="Axlsx::Styles (class)">Styles</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/TableStyle.html" title="Axlsx::TableStyle (class)">TableStyle</a></span> < SimpleTypedList<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/TableStyleElement.html" title="Axlsx::TableStyleElement (class)">TableStyleElement</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/TableStyles.html" title="Axlsx::TableStyles (class)">TableStyles</a></span> < SimpleTypedList<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Title.html" title="Axlsx::Title (class)">Title</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/TwoCellAnchor.html" title="Axlsx::TwoCellAnchor (class)">TwoCellAnchor</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/ValAxis.html" title="Axlsx::ValAxis (class)">ValAxis</a></span> < Axis<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/ValAxisData.html" title="Axlsx::ValAxisData (class)">ValAxisData</a></span> < CatAxisData<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/View3D.html" title="Axlsx::View3D (class)">View3D</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span> < Object<small class='search_info'>Axlsx</small></li><li><span class='object_link'><a href="Axlsx/Xf.html" title="Axlsx::Xf (class)">Xf</a></span> < Object<small class='search_info'>Axlsx</small></li></ul> </ul> </div> diff --git a/doc/file.LICENSE.html b/doc/file.LICENSE.html index 239b148f..6841b470 100644 --- a/doc/file.LICENSE.html +++ b/doc/file.LICENSE.html @@ -2,7 +2,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title> File: LICENSE @@ -54,32 +54,37 @@ <iframe id="search_frame"></iframe> - <div id="content"><div id='filecontents'> -<p>Copyright © 2011 Randy Morgan</p> - -<p>Permission is hereby granted, free of charge, to any person obtaining a -copy of this software and associated documentation files (the “Software”), -to deal in the Software without restriction, including without limitation -the rights to use, copy, modify, merge, publish, distribute, sublicense, -and/or sell copies of the Software, and to permit persons to whom the -Software is furnished to do so, subject to the following conditions:</p> - -<p>The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software.</p> - -<p>THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -DEALINGS IN THE SOFTWARE.</p> + <div id="content"><div id='filecontents'><p> +Copyright © 2011 Randy Morgan +</p> +<p> +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, +including without limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to the +following conditions: +</p> +<p> +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. +</p> +<p> +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN +NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, +DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR +OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE +USE OR OTHER DEALINGS IN THE SOFTWARE. +</p> </div></div> <div id="footer"> - Generated on Sat Nov 26 13:16:35 2011 by + Generated on Sun Nov 27 18:05:01 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/file.README.html b/doc/file.README.html index f76e610f..3d433391 100644 --- a/doc/file.README.html +++ b/doc/file.README.html @@ -2,7 +2,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title> File: README @@ -61,7 +61,7 @@ <strong>Author</strong>: Randy Morgan <br/> <strong>Copyright</strong>: 2011 <br/> <strong>License</strong>: MIT License <br/> -<strong>Latest Version</strong>: 1.0.9 <br/> +<strong>Latest Version</strong>: 1.0.10 <br/> <strong>Ruby Version</strong>: 1.8.7 - 1.9.3 <br/> <strong>Release Date</strong>: November 26th 2011</p> @@ -90,145 +90,202 @@ With Axlsx you can create worksheets with charts, images, automated column width <p>**7. Add jpg, gif and png images to worksheets</p> +<p>**8. Build in mixin with Active record. simply add acts_as_xlsx to you models and they will support to_xlsx</p> + <h2>Installing</h2> <p>To install Axlsx, use the following command:</p> -<pre class="code">$ gem install axlsx +<pre class="code">$ <span class='gem identifier id'>gem</span> <span class='install identifier id'>install</span> <span class='axlsx identifier id'>axlsx</span> </pre> <h2>Usage</h2> <h3>Examples</h3> -<pre class="code"> <span class='id require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>rubygems</span><span class='tstring_end'>'</span></span> - <span class='id require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>axlsx</span><span class='tstring_end'>'</span></span> +<pre class="code"> <span class='require identifier id'>require</span> <span class='string val'>'rubygems'</span> + <span class='require identifier id'>require</span> <span class='string val'>'axlsx'</span> </pre> <p>A Simple Workbook</p> -<pre class="code"> <span class='id p'>p</span> <span class='op'>=</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id add_worksheet'>add_worksheet</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id sheet'>sheet</span><span class='op'>|</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>First</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Second</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Third</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='int'>1</span><span class='comma'>,</span> <span class='int'>2</span><span class='comma'>,</span> <span class='int'>3</span><span class='rbracket'>]</span> - <span class='kw'>end</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id serialize'>serialize</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>example1.xlsx</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> +<pre class="code"> <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"First"</span><span class='comma token'>,</span> <span class='string val'>"Second"</span><span class='comma token'>,</span> <span class='string val'>"Third"</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>3</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>"example1.xlsx"</span><span class='rparen token'>)</span> </pre> <p>Generating A Bar Chart</p> -<pre class="code"> <span class='id p'>p</span> <span class='op'>=</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id add_worksheet'>add_worksheet</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id sheet'>sheet</span><span class='op'>|</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>First</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Second</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Third</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='int'>1</span><span class='comma'>,</span> <span class='int'>2</span><span class='comma'>,</span> <span class='int'>3</span><span class='rbracket'>]</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_chart'>add_chart</span><span class='lparen'>(</span><span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Bar3DChart</span><span class='comma'>,</span> <span class='symbol'>:start_at</span> <span class='op'>=></span> <span class='lbracket'>[</span><span class='int'>0</span><span class='comma'>,</span><span class='int'>2</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:end_at</span> <span class='op'>=></span> <span class='lbracket'>[</span><span class='int'>5</span><span class='comma'>,</span> <span class='int'>15</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:title</span><span class='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>example 2: Chart</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id chart'>chart</span><span class='op'>|</span> - <span class='id chart'>chart</span><span class='period'>.</span><span class='id add_series'>add_series</span> <span class='symbol'>:data</span><span class='op'>=></span><span class='id sheet'>sheet</span><span class='period'>.</span><span class='id rows'>rows</span><span class='period'>.</span><span class='id last'>last</span><span class='period'>.</span><span class='id cells'>cells</span><span class='comma'>,</span> <span class='symbol'>:labels</span><span class='op'>=></span> <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id rows'>rows</span><span class='period'>.</span><span class='id first'>first</span><span class='period'>.</span><span class='id cells'>cells</span> - <span class='kw'>end</span> - <span class='kw'>end</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id serialize'>serialize</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>example2.xlsx</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> +<pre class="code"> <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"First"</span><span class='comma token'>,</span> <span class='string val'>"Second"</span><span class='comma token'>,</span> <span class='string val'>"Third"</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>3</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Bar3DChart constant id'>Bar3DChart</span><span class='comma token'>,</span> <span class='symbol val'>:start_at</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>2</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:end_at</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>5</span><span class='comma token'>,</span> <span class='integer val'>15</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:title=</span><span class='gt op'>></span><span class='string val'>"example 2: Chart"</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='chart identifier id'>chart</span><span class='bitor op'>|</span> + <span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='add_series identifier id'>add_series</span> <span class='symbol val'>:data=</span><span class='gt op'>></span><span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='comma token'>,</span> <span class='symbol val'>:labels=</span><span class='gt op'>></span> <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span> + <span class='end end kw'>end</span> + <span class='end end kw'>end</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>"example2.xlsx"</span><span class='rparen token'>)</span> </pre> <p>Generating A Pie Chart</p> -<pre class="code"> <span class='id p'>p</span> <span class='op'>=</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id add_worksheet'>add_worksheet</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id sheet'>sheet</span><span class='op'>|</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>First</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Second</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Third</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='int'>1</span><span class='comma'>,</span> <span class='int'>2</span><span class='comma'>,</span> <span class='int'>3</span><span class='rbracket'>]</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_chart'>add_chart</span><span class='lparen'>(</span><span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Pie3DChart</span><span class='comma'>,</span> <span class='symbol'>:start_at</span> <span class='op'>=></span> <span class='lbracket'>[</span><span class='int'>0</span><span class='comma'>,</span><span class='int'>2</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:end_at</span> <span class='op'>=></span> <span class='lbracket'>[</span><span class='int'>5</span><span class='comma'>,</span> <span class='int'>15</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:title</span><span class='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>example 3: Pie Chart</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id chart'>chart</span><span class='op'>|</span> - <span class='id chart'>chart</span><span class='period'>.</span><span class='id add_series'>add_series</span> <span class='symbol'>:data</span><span class='op'>=></span><span class='id sheet'>sheet</span><span class='period'>.</span><span class='id rows'>rows</span><span class='period'>.</span><span class='id last'>last</span><span class='period'>.</span><span class='id cells'>cells</span><span class='comma'>,</span> <span class='symbol'>:labels</span><span class='op'>=></span> <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id rows'>rows</span><span class='period'>.</span><span class='id first'>first</span><span class='period'>.</span><span class='id cells'>cells</span> - <span class='kw'>end</span> - <span class='kw'>end</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id serialize'>serialize</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>example3.xlsx</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> +<pre class="code"> <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"First"</span><span class='comma token'>,</span> <span class='string val'>"Second"</span><span class='comma token'>,</span> <span class='string val'>"Third"</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>3</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Pie3DChart constant id'>Pie3DChart</span><span class='comma token'>,</span> <span class='symbol val'>:start_at</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>2</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:end_at</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>5</span><span class='comma token'>,</span> <span class='integer val'>15</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:title=</span><span class='gt op'>></span><span class='string val'>"example 3: Pie Chart"</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='chart identifier id'>chart</span><span class='bitor op'>|</span> + <span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='add_series identifier id'>add_series</span> <span class='symbol val'>:data=</span><span class='gt op'>></span><span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='comma token'>,</span> <span class='symbol val'>:labels=</span><span class='gt op'>></span> <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span> + <span class='end end kw'>end</span> + <span class='end end kw'>end</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>"example3.xlsx"</span><span class='rparen token'>)</span> </pre> <p>Using Custom Styles</p> -<pre class="code"> <span class='id p'>p</span> <span class='op'>=</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span> - <span class='id wb'>wb</span> <span class='op'>=</span> <span class='id p'>p</span><span class='period'>.</span><span class='id workbook'>workbook</span> - <span class='id black_cell'>black_cell</span> <span class='op'>=</span> <span class='id wb'>wb</span><span class='period'>.</span><span class='id styles'>styles</span><span class='period'>.</span><span class='id add_style'>add_style</span> <span class='symbol'>:bg_color</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>FF000000</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='symbol'>:fg_color</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>FFFFFFFF</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='symbol'>:sz</span><span class='op'>=></span><span class='int'>14</span><span class='comma'>,</span> <span class='symbol'>:alignment</span> <span class='op'>=></span> <span class='lbrace'>{</span> <span class='symbol'>:horizontal</span><span class='op'>=></span> <span class='symbol'>:center</span> <span class='rbrace'>}</span> - <span class='id blue_cell'>blue_cell</span> <span class='op'>=</span> <span class='id wb'>wb</span><span class='period'>.</span><span class='id styles'>styles</span><span class='period'>.</span><span class='id add_style'>add_style</span> <span class='symbol'>:bg_color</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>FF0000FF</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='symbol'>:fg_color</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>FFFFFFFF</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='symbol'>:sz</span><span class='op'>=></span><span class='int'>14</span><span class='comma'>,</span> <span class='symbol'>:alignment</span> <span class='op'>=></span> <span class='lbrace'>{</span> <span class='symbol'>:horizontal</span><span class='op'>=></span> <span class='symbol'>:center</span> <span class='rbrace'>}</span> - <span class='id wb'>wb</span><span class='period'>.</span><span class='id add_worksheet'>add_worksheet</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id sheet'>sheet</span><span class='op'>|</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Text Autowidth</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Second</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Third</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:style</span> <span class='op'>=></span> <span class='lbracket'>[</span><span class='id black_cell'>black_cell</span><span class='comma'>,</span> <span class='id blue_cell'>blue_cell</span><span class='comma'>,</span> <span class='id black_cell'>black_cell</span><span class='rbracket'>]</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='int'>1</span><span class='comma'>,</span> <span class='int'>2</span><span class='comma'>,</span> <span class='int'>3</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:style</span> <span class='op'>=></span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>STYLE_THIN_BORDER</span> - <span class='kw'>end</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id serialize'>serialize</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>example4.xlsx</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> +<pre class="code"> <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='wb identifier id'>wb</span> <span class='assign token'>=</span> <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span> + <span class='black_cell identifier id'>black_cell</span> <span class='assign token'>=</span> <span class='wb identifier id'>wb</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span> <span class='symbol val'>:bg_color</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"FF000000"</span><span class='comma token'>,</span> <span class='symbol val'>:fg_color</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"FFFFFFFF"</span><span class='comma token'>,</span> <span class='symbol val'>:sz=</span><span class='gt op'>></span><span class='integer val'>14</span><span class='comma token'>,</span> <span class='symbol val'>:alignment</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrace token'>{</span> <span class='symbol val'>:horizontal=</span><span class='gt op'>></span> <span class='symbol val'>:center</span> <span class='rbrace token'>}</span> + <span class='blue_cell identifier id'>blue_cell</span> <span class='assign token'>=</span> <span class='wb identifier id'>wb</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span> <span class='symbol val'>:bg_color</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"FF0000FF"</span><span class='comma token'>,</span> <span class='symbol val'>:fg_color</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"FFFFFFFF"</span><span class='comma token'>,</span> <span class='symbol val'>:sz=</span><span class='gt op'>></span><span class='integer val'>14</span><span class='comma token'>,</span> <span class='symbol val'>:alignment</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrace token'>{</span> <span class='symbol val'>:horizontal=</span><span class='gt op'>></span> <span class='symbol val'>:center</span> <span class='rbrace token'>}</span> + <span class='wb identifier id'>wb</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"Text Autowidth"</span><span class='comma token'>,</span> <span class='string val'>"Second"</span><span class='comma token'>,</span> <span class='string val'>"Third"</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='black_cell identifier id'>black_cell</span><span class='comma token'>,</span> <span class='blue_cell identifier id'>blue_cell</span><span class='comma token'>,</span> <span class='black_cell identifier id'>black_cell</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>3</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span> + <span class='end end kw'>end</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>"example4.xlsx"</span><span class='rparen token'>)</span> </pre> <p>Using Custom Formatting and date1904</p> -<pre class="code"> <span class='id p'>p</span> <span class='op'>=</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span> - <span class='id wb'>wb</span> <span class='op'>=</span> <span class='id p'>p</span><span class='period'>.</span><span class='id workbook'>workbook</span> - <span class='id date'>date</span> <span class='op'>=</span> <span class='id wb'>wb</span><span class='period'>.</span><span class='id styles'>styles</span><span class='period'>.</span><span class='id add_style'>add_style</span> <span class='symbol'>:format_code</span><span class='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>yyyy-mm-dd</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='symbol'>:border</span> <span class='op'>=></span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>STYLE_THIN_BORDER</span> - <span class='id padded'>padded</span> <span class='op'>=</span> <span class='id wb'>wb</span><span class='period'>.</span><span class='id styles'>styles</span><span class='period'>.</span><span class='id add_style'>add_style</span> <span class='symbol'>:format_code</span><span class='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>00#</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='symbol'>:border</span> <span class='op'>=></span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>STYLE_THIN_BORDER</span> - <span class='id percent'>percent</span> <span class='op'>=</span> <span class='id wb'>wb</span><span class='period'>.</span><span class='id styles'>styles</span><span class='period'>.</span><span class='id add_style'>add_style</span> <span class='symbol'>:format_code</span><span class='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>0%</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='symbol'>:border</span> <span class='op'>=></span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>STYLE_THIN_BORDER</span> - <span class='id wb'>wb</span><span class='period'>.</span><span class='id date1904'>date1904</span> <span class='op'>=</span> <span class='kw'>true</span> <span class='comment'># required for generation on mac -</span> <span class='id wb'>wb</span><span class='period'>.</span><span class='id add_worksheet'>add_worksheet</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id sheet'>sheet</span><span class='op'>|</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Custom Formatted Date</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Percent Formatted Float</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Padded Numbers</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:style</span> <span class='op'>=></span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>STYLE_THIN_BORDER</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='const'>Time</span><span class='period'>.</span><span class='id now'>now</span><span class='comma'>,</span> <span class='float'>0.2</span><span class='comma'>,</span> <span class='int'>32</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:style</span> <span class='op'>=></span> <span class='lbracket'>[</span><span class='id date'>date</span><span class='comma'>,</span> <span class='id percent'>percent</span><span class='comma'>,</span> <span class='id padded'>padded</span><span class='rbracket'>]</span> - <span class='kw'>end</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id serialize'>serialize</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>example5.xlsx</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> +<pre class="code"> <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='wb identifier id'>wb</span> <span class='assign token'>=</span> <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span> + <span class='date identifier id'>date</span> <span class='assign token'>=</span> <span class='wb identifier id'>wb</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span> <span class='symbol val'>:format_code=</span><span class='gt op'>></span><span class='string val'>"yyyy-mm-dd"</span><span class='comma token'>,</span> <span class='symbol val'>:border</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span> + <span class='padded identifier id'>padded</span> <span class='assign token'>=</span> <span class='wb identifier id'>wb</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span> <span class='symbol val'>:format_code=</span><span class='gt op'>></span><span class='string val'>"00#"</span><span class='comma token'>,</span> <span class='symbol val'>:border</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span> + <span class='percent identifier id'>percent</span> <span class='assign token'>=</span> <span class='wb identifier id'>wb</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span> <span class='symbol val'>:format_code=</span><span class='gt op'>></span><span class='string val'>"0%"</span><span class='comma token'>,</span> <span class='symbol val'>:border</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span> + <span class='wb identifier id'>wb</span><span class='dot token'>.</span><span class='date1904 identifier id'>date1904</span> <span class='assign token'>=</span> <span class='true true kw'>true</span> <span class='comment val'># required for generation on mac</span> + <span class='wb identifier id'>wb</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"Custom Formatted Date"</span><span class='comma token'>,</span> <span class='string val'>"Percent Formatted Float"</span><span class='comma token'>,</span> <span class='string val'>"Padded Numbers"</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='Time constant id'>Time</span><span class='dot token'>.</span><span class='now identifier id'>now</span><span class='comma token'>,</span> <span class='integer val'>0</span><span class='integer val'>.2</span><span class='comma token'>,</span> <span class='integer val'>32</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='date identifier id'>date</span><span class='comma token'>,</span> <span class='percent identifier id'>percent</span><span class='comma token'>,</span> <span class='padded identifier id'>padded</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>"example5.xlsx"</span><span class='rparen token'>)</span> </pre> <p>Validation</p> -<pre class="code"> <span class='id p'>p</span> <span class='op'>=</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id add_worksheet'>add_worksheet</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id sheet'>sheet</span><span class='op'>|</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>First</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Second</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Third</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='int'>1</span><span class='comma'>,</span> <span class='int'>2</span><span class='comma'>,</span> <span class='int'>3</span><span class='rbracket'>]</span> - <span class='kw'>end</span> +<pre class="code"> <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"First"</span><span class='comma token'>,</span> <span class='string val'>"Second"</span><span class='comma token'>,</span> <span class='string val'>"Third"</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>3</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id validate'>validate</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id error'>error</span><span class='op'>|</span> - <span class='id puts'>puts</span> <span class='id error'>error</span><span class='period'>.</span><span class='id inspect'>inspect</span> - <span class='kw'>end</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='error identifier id'>error</span><span class='bitor op'>|</span> + <span class='puts identifier id'>puts</span> <span class='error identifier id'>error</span><span class='dot token'>.</span><span class='inspect identifier id'>inspect</span> + <span class='end end kw'>end</span> </pre> <p>Generating A Line Chart</p> -<pre class="code"> <span class='id p'>p</span> <span class='op'>=</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id add_worksheet'>add_worksheet</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id sheet'>sheet</span><span class='op'>|</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>First</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='int'>1</span><span class='comma'>,</span> <span class='int'>5</span><span class='comma'>,</span> <span class='int'>7</span><span class='comma'>,</span> <span class='int'>9</span><span class='rbracket'>]</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Second</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='int'>5</span><span class='comma'>,</span> <span class='int'>2</span><span class='comma'>,</span> <span class='int'>14</span><span class='comma'>,</span> <span class='int'>9</span><span class='rbracket'>]</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_chart'>add_chart</span><span class='lparen'>(</span><span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Line3DChart</span><span class='comma'>,</span> <span class='symbol'>:title</span><span class='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>example 6: Line Chart</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id chart'>chart</span><span class='op'>|</span> - <span class='id chart'>chart</span><span class='period'>.</span><span class='id start_at'>start_at</span> <span class='int'>0</span><span class='comma'>,</span> <span class='int'>2</span> - <span class='id chart'>chart</span><span class='period'>.</span><span class='id end_at'>end_at</span> <span class='int'>10</span><span class='comma'>,</span> <span class='int'>15</span> - <span class='id chart'>chart</span><span class='period'>.</span><span class='id add_series'>add_series</span> <span class='symbol'>:data</span><span class='op'>=></span><span class='id sheet'>sheet</span><span class='period'>.</span><span class='id rows'>rows</span><span class='period'>.</span><span class='id first'>first</span><span class='period'>.</span><span class='id cells'>cells</span><span class='lbracket'>[</span><span class='lparen'>(</span><span class='int'>1</span><span class='op'>..</span><span class='op'>-</span><span class='int'>1</span><span class='rparen'>)</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:title</span><span class='op'>=></span> <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id rows'>rows</span><span class='period'>.</span><span class='id first'>first</span><span class='period'>.</span><span class='id cells'>cells</span><span class='period'>.</span><span class='id first'>first</span> - <span class='id chart'>chart</span><span class='period'>.</span><span class='id add_series'>add_series</span> <span class='symbol'>:data</span><span class='op'>=></span><span class='id sheet'>sheet</span><span class='period'>.</span><span class='id rows'>rows</span><span class='period'>.</span><span class='id last'>last</span><span class='period'>.</span><span class='id cells'>cells</span><span class='lbracket'>[</span><span class='lparen'>(</span><span class='int'>1</span><span class='op'>..</span><span class='op'>-</span><span class='int'>1</span><span class='rparen'>)</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:title</span><span class='op'>=></span> <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id rows'>rows</span><span class='period'>.</span><span class='id last'>last</span><span class='period'>.</span><span class='id cells'>cells</span><span class='period'>.</span><span class='id first'>first</span> - <span class='kw'>end</span> - - <span class='kw'>end</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id serialize'>serialize</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>example6.xlsx</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> +<pre class="code"> <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"First"</span><span class='comma token'>,</span> <span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>5</span><span class='comma token'>,</span> <span class='integer val'>7</span><span class='comma token'>,</span> <span class='integer val'>9</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"Second"</span><span class='comma token'>,</span> <span class='integer val'>5</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>14</span><span class='comma token'>,</span> <span class='integer val'>9</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Line3DChart constant id'>Line3DChart</span><span class='comma token'>,</span> <span class='symbol val'>:title=</span><span class='gt op'>></span><span class='string val'>"example 6: Line Chart"</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='chart identifier id'>chart</span><span class='bitor op'>|</span> + <span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='start_at identifier id'>start_at</span> <span class='integer val'>0</span><span class='comma token'>,</span> <span class='integer val'>2</span> + <span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='end_at identifier id'>end_at</span> <span class='integer val'>10</span><span class='comma token'>,</span> <span class='integer val'>15</span> + <span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='add_series identifier id'>add_series</span> <span class='symbol val'>:data=</span><span class='gt op'>></span><span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='lbrack token'>[</span><span class='lparen token'>(</span><span class='float val'>1</span><span class='dot2 op'>..</span><span class='integer val'>-1</span><span class='rparen token'>)</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:title=</span><span class='gt op'>></span> <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='first identifier id'>first</span> + <span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='add_series identifier id'>add_series</span> <span class='symbol val'>:data=</span><span class='gt op'>></span><span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='lbrack token'>[</span><span class='lparen token'>(</span><span class='float val'>1</span><span class='dot2 op'>..</span><span class='integer val'>-1</span><span class='rparen token'>)</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:title=</span><span class='gt op'>></span> <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='first identifier id'>first</span> + <span class='end end kw'>end</span> + + <span class='end end kw'>end</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>"example6.xlsx"</span><span class='rparen token'>)</span> </pre> <p>Adding an Image</p> -<pre class="code"> <span class='id p'>p</span> <span class='op'>=</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id add_worksheet'>add_worksheet</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id sheet'>sheet</span><span class='op'>|</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_image'>add_image</span><span class='lparen'>(</span><span class='symbol'>:image_src</span> <span class='op'>=></span> <span class='lparen'>(</span><span class='const'>File</span><span class='period'>.</span><span class='id dirname'>dirname</span><span class='lparen'>(</span><span class='kw'>__FILE__</span><span class='rparen'>)</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/image1.png</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id image'>image</span><span class='op'>|</span> - <span class='id image'>image</span><span class='period'>.</span><span class='id width'>width</span><span class='op'>=</span><span class='int'>720</span> - <span class='id image'>image</span><span class='period'>.</span><span class='id height'>height</span><span class='op'>=</span><span class='int'>666</span> - <span class='id image'>image</span><span class='period'>.</span><span class='id start_at'>start_at</span> <span class='int'>2</span><span class='comma'>,</span> <span class='int'>2</span> - <span class='kw'>end</span> - <span class='kw'>end</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id serialize'>serialize</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>example7.xlsx</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> +<pre class="code"> <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_image identifier id'>add_image</span><span class='lparen token'>(</span><span class='symbol val'>:image_src</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lparen token'>(</span><span class='File constant id'>File</span><span class='dot token'>.</span><span class='dirname identifier id'>dirname</span><span class='lparen token'>(</span><span class='__FILE__ __file__ kw'>__FILE__</span><span class='rparen token'>)</span> <span class='plus op'>+</span> <span class='string val'>"/image1.png"</span><span class='rparen token'>)</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='image identifier id'>image</span><span class='bitor op'>|</span> + <span class='image identifier id'>image</span><span class='dot token'>.</span><span class='width identifier id'>width</span><span class='assign token'>=</span><span class='integer val'>720</span> + <span class='image identifier id'>image</span><span class='dot token'>.</span><span class='height identifier id'>height</span><span class='assign token'>=</span><span class='integer val'>666</span> + <span class='image identifier id'>image</span><span class='dot token'>.</span><span class='start_at identifier id'>start_at</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>2</span> + <span class='end end kw'>end</span> + <span class='end end kw'>end</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>"example7.xlsx"</span><span class='rparen token'>)</span> </pre> <p>Asian Language Support</p> -<pre class="code"> <span class='id p'>p</span> <span class='op'>=</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id add_worksheet'>add_worksheet</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id sheet'>sheet</span><span class='op'>|</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>日本語</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>华语/華語</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>한국어/조선말</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> - <span class='kw'>end</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id serialize'>serialize</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>example8.xlsx</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> +<pre class="code"> <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"日本語"</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"华语/華語"</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"한국어/조선말"</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>"example8.xlsx"</span><span class='rparen token'>)</span> +</pre> + +<p>Styling Columns</p> + +<pre class="code"> <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='percent identifier id'>percent</span> <span class='assign token'>=</span> <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span> <span class='symbol val'>:num_fmt</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='integer val'>9</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>'col 1'</span><span class='comma token'>,</span> <span class='string val'>'col 2'</span><span class='comma token'>,</span> <span class='string val'>'col 3'</span><span class='comma token'>,</span> <span class='string val'>'col 4'</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>0</span><span class='integer val'>.3</span><span class='comma token'>,</span> <span class='integer val'>4</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>0</span><span class='integer val'>.2</span><span class='comma token'>,</span> <span class='integer val'>4</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>0</span><span class='integer val'>.1</span><span class='comma token'>,</span> <span class='integer val'>4</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='worksheets identifier id'>worksheets</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='col_style identifier id'>col_style</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='percent identifier id'>percent</span><span class='comma token'>,</span> <span class='symbol val'>:row_offset=</span><span class='gt op'>></span><span class='integer val'>1</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>"example10.xlsx"</span><span class='rparen token'>)</span> +</pre> + +<p>Styling Rows</p> + +<pre class="code"> <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>'col 1'</span><span class='comma token'>,</span> <span class='string val'>'col 2'</span><span class='comma token'>,</span> <span class='string val'>'col 3'</span><span class='comma token'>,</span> <span class='string val'>'col 4'</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>0</span><span class='integer val'>.3</span><span class='comma token'>,</span> <span class='integer val'>4</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>0</span><span class='integer val'>.2</span><span class='comma token'>,</span> <span class='integer val'>4</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>0</span><span class='integer val'>.1</span><span class='comma token'>,</span> <span class='integer val'>4</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> + <span class='head identifier id'>head</span> <span class='assign token'>=</span> <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span> <span class='symbol val'>:bg_color</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"FF000000"</span><span class='comma token'>,</span> <span class='symbol val'>:fg_color=</span><span class='gt op'>></span><span class='string val'>"FFFFFFFF"</span> + <span class='percent identifier id'>percent</span> <span class='assign token'>=</span> <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span> <span class='symbol val'>:num_fmt</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='integer val'>9</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='worksheets identifier id'>worksheets</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='col_style identifier id'>col_style</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='percent identifier id'>percent</span><span class='comma token'>,</span> <span class='symbol val'>:row_offset=</span><span class='gt op'>></span><span class='integer val'>1</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='worksheets identifier id'>worksheets</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='row_style identifier id'>row_style</span> <span class='integer val'>0</span><span class='comma token'>,</span> <span class='head identifier id'>head</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>"example11.xlsx"</span><span class='rparen token'>)</span> +</pre> + +<p>Rails 3</p> + +<pre class="code"> <span class='comment val'># 1. Add the gem to your Gemfile and bundle install</span> + + <span class='gem identifier id'>gem</span> <span class='string val'>'axlsx'</span> + + <span class='comment val'># 2. Add 'acts_as_axslx' to your model</span> + + <span class='class class kw'>class</span> <span class='MyModel constant id'>MyModel</span> <span class='lt op'><</span> <span class='ActiveRecord constant id'>ActiveRecord</span><span class='colon2 op'>::</span><span class='Base constant id'>Base</span> + <span class='acts_as_axlsx identifier id'>acts_as_axlsx</span> + <span class='end end kw'>end</span> + + <span class='comment val'># 3. In your controlle, simply call to_xlsx against the class</span> + + <span class='class class kw'>class</span> <span class='MyModelController constant id'>MyModelController</span> <span class='lt op'><</span> <span class='ApplicationController constant id'>ApplicationController</span> + + <span class='comment val'>#GET /posts/xlsx</span> + <span class='def def kw'>def</span> <span class='xlsx identifier id'>xlsx</span> + <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='MyModel constant id'>MyModel</span><span class='dot token'>.</span><span class='since identifier id'>since</span><span class='lparen token'>(</span><span class='Time constant id'>Time</span><span class='dot token'>.</span><span class='now identifier id'>now</span> <span class='minus op'>-</span> <span class='float val'>5</span><span class='dot token'>.</span><span class='days identifier id'>days</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='to_xlsx identifier id'>to_xlsx</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>'my_model.xlsx'</span><span class='rparen token'>)</span> + <span class='send_file identifier id'>send_file</span> <span class='string val'>'my_model.xlsx'</span><span class='comma token'>,</span> <span class='symbol val'>:type=</span><span class='gt op'>></span><span class='string val'>"application/xlsx"</span><span class='comma token'>,</span> <span class='symbol val'>:x_sendfile=</span><span class='gt op'>></span><span class='true true kw'>true</span> + <span class='end end kw'>end</span> + <span class='end end kw'>end</span> </pre> <h3>Documentation</h3> <p>This gem is 100% documented with YARD, an exceptional documentation library. To see documentation for this, and all the gems installed on your system use:</p> -<pre class="code"> <span class='id gem'>gem</span> <span class='id install'>install</span> <span class='id yard'>yard</span> - <span class='id yard'>yard</span> <span class='id server'>server</span> <span class='op'>-</span><span class='id g'>g</span> +<pre class="code"> <span class='gem identifier id'>gem</span> <span class='install identifier id'>install</span> <span class='yard identifier id'>yard</span> + <span class='yard identifier id'>yard</span> <span class='server identifier id'>server</span> <span class='minus op'>-</span><span class='g identifier id'>g</span> </pre> <h3>Specs</h3> @@ -238,7 +295,16 @@ With Axlsx you can create worksheets with charts, images, automated column width <h2>Changelog</h2> <ul> -<li><strong>October.26.11</strong>: 1.0.9 release +<li><p><strong>October.27.11</strong>: 1.0.10 release</p> + +<ul> +<li>Updating gemspec to be compatible with rails3 requirements</li> +<li>Added acts_as_xlsx mixin for rails3 See Examples</li> +<li>Added row.style assignation for updating the cell style for an entire row</li> +<li>Added col_style method to worksheet upate a the style for a column of cells</li> +</ul> +</li> +<li><p><strong>October.26.11</strong>: 1.0.9 release</p> <ul> <li>Updated to support ruby 1.9.3</li> @@ -257,9 +323,9 @@ licensed under the MIT license. Please see the <a href="file.LICENSE.html" title </div></div> <div id="footer"> - Generated on Sat Nov 26 13:16:35 2011 by + Generated on Sun Nov 27 18:05:01 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/index.html b/doc/index.html index f76e610f..3d433391 100644 --- a/doc/index.html +++ b/doc/index.html @@ -2,7 +2,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title> File: README @@ -61,7 +61,7 @@ <strong>Author</strong>: Randy Morgan <br/> <strong>Copyright</strong>: 2011 <br/> <strong>License</strong>: MIT License <br/> -<strong>Latest Version</strong>: 1.0.9 <br/> +<strong>Latest Version</strong>: 1.0.10 <br/> <strong>Ruby Version</strong>: 1.8.7 - 1.9.3 <br/> <strong>Release Date</strong>: November 26th 2011</p> @@ -90,145 +90,202 @@ With Axlsx you can create worksheets with charts, images, automated column width <p>**7. Add jpg, gif and png images to worksheets</p> +<p>**8. Build in mixin with Active record. simply add acts_as_xlsx to you models and they will support to_xlsx</p> + <h2>Installing</h2> <p>To install Axlsx, use the following command:</p> -<pre class="code">$ gem install axlsx +<pre class="code">$ <span class='gem identifier id'>gem</span> <span class='install identifier id'>install</span> <span class='axlsx identifier id'>axlsx</span> </pre> <h2>Usage</h2> <h3>Examples</h3> -<pre class="code"> <span class='id require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>rubygems</span><span class='tstring_end'>'</span></span> - <span class='id require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>axlsx</span><span class='tstring_end'>'</span></span> +<pre class="code"> <span class='require identifier id'>require</span> <span class='string val'>'rubygems'</span> + <span class='require identifier id'>require</span> <span class='string val'>'axlsx'</span> </pre> <p>A Simple Workbook</p> -<pre class="code"> <span class='id p'>p</span> <span class='op'>=</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id add_worksheet'>add_worksheet</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id sheet'>sheet</span><span class='op'>|</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>First</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Second</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Third</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='int'>1</span><span class='comma'>,</span> <span class='int'>2</span><span class='comma'>,</span> <span class='int'>3</span><span class='rbracket'>]</span> - <span class='kw'>end</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id serialize'>serialize</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>example1.xlsx</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> +<pre class="code"> <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"First"</span><span class='comma token'>,</span> <span class='string val'>"Second"</span><span class='comma token'>,</span> <span class='string val'>"Third"</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>3</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>"example1.xlsx"</span><span class='rparen token'>)</span> </pre> <p>Generating A Bar Chart</p> -<pre class="code"> <span class='id p'>p</span> <span class='op'>=</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id add_worksheet'>add_worksheet</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id sheet'>sheet</span><span class='op'>|</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>First</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Second</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Third</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='int'>1</span><span class='comma'>,</span> <span class='int'>2</span><span class='comma'>,</span> <span class='int'>3</span><span class='rbracket'>]</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_chart'>add_chart</span><span class='lparen'>(</span><span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Bar3DChart</span><span class='comma'>,</span> <span class='symbol'>:start_at</span> <span class='op'>=></span> <span class='lbracket'>[</span><span class='int'>0</span><span class='comma'>,</span><span class='int'>2</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:end_at</span> <span class='op'>=></span> <span class='lbracket'>[</span><span class='int'>5</span><span class='comma'>,</span> <span class='int'>15</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:title</span><span class='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>example 2: Chart</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id chart'>chart</span><span class='op'>|</span> - <span class='id chart'>chart</span><span class='period'>.</span><span class='id add_series'>add_series</span> <span class='symbol'>:data</span><span class='op'>=></span><span class='id sheet'>sheet</span><span class='period'>.</span><span class='id rows'>rows</span><span class='period'>.</span><span class='id last'>last</span><span class='period'>.</span><span class='id cells'>cells</span><span class='comma'>,</span> <span class='symbol'>:labels</span><span class='op'>=></span> <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id rows'>rows</span><span class='period'>.</span><span class='id first'>first</span><span class='period'>.</span><span class='id cells'>cells</span> - <span class='kw'>end</span> - <span class='kw'>end</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id serialize'>serialize</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>example2.xlsx</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> +<pre class="code"> <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"First"</span><span class='comma token'>,</span> <span class='string val'>"Second"</span><span class='comma token'>,</span> <span class='string val'>"Third"</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>3</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Bar3DChart constant id'>Bar3DChart</span><span class='comma token'>,</span> <span class='symbol val'>:start_at</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>2</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:end_at</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>5</span><span class='comma token'>,</span> <span class='integer val'>15</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:title=</span><span class='gt op'>></span><span class='string val'>"example 2: Chart"</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='chart identifier id'>chart</span><span class='bitor op'>|</span> + <span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='add_series identifier id'>add_series</span> <span class='symbol val'>:data=</span><span class='gt op'>></span><span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='comma token'>,</span> <span class='symbol val'>:labels=</span><span class='gt op'>></span> <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span> + <span class='end end kw'>end</span> + <span class='end end kw'>end</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>"example2.xlsx"</span><span class='rparen token'>)</span> </pre> <p>Generating A Pie Chart</p> -<pre class="code"> <span class='id p'>p</span> <span class='op'>=</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id add_worksheet'>add_worksheet</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id sheet'>sheet</span><span class='op'>|</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>First</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Second</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Third</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='int'>1</span><span class='comma'>,</span> <span class='int'>2</span><span class='comma'>,</span> <span class='int'>3</span><span class='rbracket'>]</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_chart'>add_chart</span><span class='lparen'>(</span><span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Pie3DChart</span><span class='comma'>,</span> <span class='symbol'>:start_at</span> <span class='op'>=></span> <span class='lbracket'>[</span><span class='int'>0</span><span class='comma'>,</span><span class='int'>2</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:end_at</span> <span class='op'>=></span> <span class='lbracket'>[</span><span class='int'>5</span><span class='comma'>,</span> <span class='int'>15</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:title</span><span class='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>example 3: Pie Chart</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id chart'>chart</span><span class='op'>|</span> - <span class='id chart'>chart</span><span class='period'>.</span><span class='id add_series'>add_series</span> <span class='symbol'>:data</span><span class='op'>=></span><span class='id sheet'>sheet</span><span class='period'>.</span><span class='id rows'>rows</span><span class='period'>.</span><span class='id last'>last</span><span class='period'>.</span><span class='id cells'>cells</span><span class='comma'>,</span> <span class='symbol'>:labels</span><span class='op'>=></span> <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id rows'>rows</span><span class='period'>.</span><span class='id first'>first</span><span class='period'>.</span><span class='id cells'>cells</span> - <span class='kw'>end</span> - <span class='kw'>end</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id serialize'>serialize</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>example3.xlsx</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> +<pre class="code"> <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"First"</span><span class='comma token'>,</span> <span class='string val'>"Second"</span><span class='comma token'>,</span> <span class='string val'>"Third"</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>3</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Pie3DChart constant id'>Pie3DChart</span><span class='comma token'>,</span> <span class='symbol val'>:start_at</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>2</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:end_at</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>5</span><span class='comma token'>,</span> <span class='integer val'>15</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:title=</span><span class='gt op'>></span><span class='string val'>"example 3: Pie Chart"</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='chart identifier id'>chart</span><span class='bitor op'>|</span> + <span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='add_series identifier id'>add_series</span> <span class='symbol val'>:data=</span><span class='gt op'>></span><span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='comma token'>,</span> <span class='symbol val'>:labels=</span><span class='gt op'>></span> <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span> + <span class='end end kw'>end</span> + <span class='end end kw'>end</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>"example3.xlsx"</span><span class='rparen token'>)</span> </pre> <p>Using Custom Styles</p> -<pre class="code"> <span class='id p'>p</span> <span class='op'>=</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span> - <span class='id wb'>wb</span> <span class='op'>=</span> <span class='id p'>p</span><span class='period'>.</span><span class='id workbook'>workbook</span> - <span class='id black_cell'>black_cell</span> <span class='op'>=</span> <span class='id wb'>wb</span><span class='period'>.</span><span class='id styles'>styles</span><span class='period'>.</span><span class='id add_style'>add_style</span> <span class='symbol'>:bg_color</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>FF000000</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='symbol'>:fg_color</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>FFFFFFFF</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='symbol'>:sz</span><span class='op'>=></span><span class='int'>14</span><span class='comma'>,</span> <span class='symbol'>:alignment</span> <span class='op'>=></span> <span class='lbrace'>{</span> <span class='symbol'>:horizontal</span><span class='op'>=></span> <span class='symbol'>:center</span> <span class='rbrace'>}</span> - <span class='id blue_cell'>blue_cell</span> <span class='op'>=</span> <span class='id wb'>wb</span><span class='period'>.</span><span class='id styles'>styles</span><span class='period'>.</span><span class='id add_style'>add_style</span> <span class='symbol'>:bg_color</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>FF0000FF</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='symbol'>:fg_color</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>FFFFFFFF</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='symbol'>:sz</span><span class='op'>=></span><span class='int'>14</span><span class='comma'>,</span> <span class='symbol'>:alignment</span> <span class='op'>=></span> <span class='lbrace'>{</span> <span class='symbol'>:horizontal</span><span class='op'>=></span> <span class='symbol'>:center</span> <span class='rbrace'>}</span> - <span class='id wb'>wb</span><span class='period'>.</span><span class='id add_worksheet'>add_worksheet</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id sheet'>sheet</span><span class='op'>|</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Text Autowidth</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Second</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Third</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:style</span> <span class='op'>=></span> <span class='lbracket'>[</span><span class='id black_cell'>black_cell</span><span class='comma'>,</span> <span class='id blue_cell'>blue_cell</span><span class='comma'>,</span> <span class='id black_cell'>black_cell</span><span class='rbracket'>]</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='int'>1</span><span class='comma'>,</span> <span class='int'>2</span><span class='comma'>,</span> <span class='int'>3</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:style</span> <span class='op'>=></span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>STYLE_THIN_BORDER</span> - <span class='kw'>end</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id serialize'>serialize</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>example4.xlsx</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> +<pre class="code"> <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='wb identifier id'>wb</span> <span class='assign token'>=</span> <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span> + <span class='black_cell identifier id'>black_cell</span> <span class='assign token'>=</span> <span class='wb identifier id'>wb</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span> <span class='symbol val'>:bg_color</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"FF000000"</span><span class='comma token'>,</span> <span class='symbol val'>:fg_color</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"FFFFFFFF"</span><span class='comma token'>,</span> <span class='symbol val'>:sz=</span><span class='gt op'>></span><span class='integer val'>14</span><span class='comma token'>,</span> <span class='symbol val'>:alignment</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrace token'>{</span> <span class='symbol val'>:horizontal=</span><span class='gt op'>></span> <span class='symbol val'>:center</span> <span class='rbrace token'>}</span> + <span class='blue_cell identifier id'>blue_cell</span> <span class='assign token'>=</span> <span class='wb identifier id'>wb</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span> <span class='symbol val'>:bg_color</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"FF0000FF"</span><span class='comma token'>,</span> <span class='symbol val'>:fg_color</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"FFFFFFFF"</span><span class='comma token'>,</span> <span class='symbol val'>:sz=</span><span class='gt op'>></span><span class='integer val'>14</span><span class='comma token'>,</span> <span class='symbol val'>:alignment</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrace token'>{</span> <span class='symbol val'>:horizontal=</span><span class='gt op'>></span> <span class='symbol val'>:center</span> <span class='rbrace token'>}</span> + <span class='wb identifier id'>wb</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"Text Autowidth"</span><span class='comma token'>,</span> <span class='string val'>"Second"</span><span class='comma token'>,</span> <span class='string val'>"Third"</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='black_cell identifier id'>black_cell</span><span class='comma token'>,</span> <span class='blue_cell identifier id'>blue_cell</span><span class='comma token'>,</span> <span class='black_cell identifier id'>black_cell</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>3</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span> + <span class='end end kw'>end</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>"example4.xlsx"</span><span class='rparen token'>)</span> </pre> <p>Using Custom Formatting and date1904</p> -<pre class="code"> <span class='id p'>p</span> <span class='op'>=</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span> - <span class='id wb'>wb</span> <span class='op'>=</span> <span class='id p'>p</span><span class='period'>.</span><span class='id workbook'>workbook</span> - <span class='id date'>date</span> <span class='op'>=</span> <span class='id wb'>wb</span><span class='period'>.</span><span class='id styles'>styles</span><span class='period'>.</span><span class='id add_style'>add_style</span> <span class='symbol'>:format_code</span><span class='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>yyyy-mm-dd</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='symbol'>:border</span> <span class='op'>=></span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>STYLE_THIN_BORDER</span> - <span class='id padded'>padded</span> <span class='op'>=</span> <span class='id wb'>wb</span><span class='period'>.</span><span class='id styles'>styles</span><span class='period'>.</span><span class='id add_style'>add_style</span> <span class='symbol'>:format_code</span><span class='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>00#</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='symbol'>:border</span> <span class='op'>=></span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>STYLE_THIN_BORDER</span> - <span class='id percent'>percent</span> <span class='op'>=</span> <span class='id wb'>wb</span><span class='period'>.</span><span class='id styles'>styles</span><span class='period'>.</span><span class='id add_style'>add_style</span> <span class='symbol'>:format_code</span><span class='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>0%</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='symbol'>:border</span> <span class='op'>=></span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>STYLE_THIN_BORDER</span> - <span class='id wb'>wb</span><span class='period'>.</span><span class='id date1904'>date1904</span> <span class='op'>=</span> <span class='kw'>true</span> <span class='comment'># required for generation on mac -</span> <span class='id wb'>wb</span><span class='period'>.</span><span class='id add_worksheet'>add_worksheet</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id sheet'>sheet</span><span class='op'>|</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Custom Formatted Date</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Percent Formatted Float</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Padded Numbers</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:style</span> <span class='op'>=></span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>STYLE_THIN_BORDER</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='const'>Time</span><span class='period'>.</span><span class='id now'>now</span><span class='comma'>,</span> <span class='float'>0.2</span><span class='comma'>,</span> <span class='int'>32</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:style</span> <span class='op'>=></span> <span class='lbracket'>[</span><span class='id date'>date</span><span class='comma'>,</span> <span class='id percent'>percent</span><span class='comma'>,</span> <span class='id padded'>padded</span><span class='rbracket'>]</span> - <span class='kw'>end</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id serialize'>serialize</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>example5.xlsx</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> +<pre class="code"> <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='wb identifier id'>wb</span> <span class='assign token'>=</span> <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span> + <span class='date identifier id'>date</span> <span class='assign token'>=</span> <span class='wb identifier id'>wb</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span> <span class='symbol val'>:format_code=</span><span class='gt op'>></span><span class='string val'>"yyyy-mm-dd"</span><span class='comma token'>,</span> <span class='symbol val'>:border</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span> + <span class='padded identifier id'>padded</span> <span class='assign token'>=</span> <span class='wb identifier id'>wb</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span> <span class='symbol val'>:format_code=</span><span class='gt op'>></span><span class='string val'>"00#"</span><span class='comma token'>,</span> <span class='symbol val'>:border</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span> + <span class='percent identifier id'>percent</span> <span class='assign token'>=</span> <span class='wb identifier id'>wb</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span> <span class='symbol val'>:format_code=</span><span class='gt op'>></span><span class='string val'>"0%"</span><span class='comma token'>,</span> <span class='symbol val'>:border</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span> + <span class='wb identifier id'>wb</span><span class='dot token'>.</span><span class='date1904 identifier id'>date1904</span> <span class='assign token'>=</span> <span class='true true kw'>true</span> <span class='comment val'># required for generation on mac</span> + <span class='wb identifier id'>wb</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"Custom Formatted Date"</span><span class='comma token'>,</span> <span class='string val'>"Percent Formatted Float"</span><span class='comma token'>,</span> <span class='string val'>"Padded Numbers"</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='Time constant id'>Time</span><span class='dot token'>.</span><span class='now identifier id'>now</span><span class='comma token'>,</span> <span class='integer val'>0</span><span class='integer val'>.2</span><span class='comma token'>,</span> <span class='integer val'>32</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='date identifier id'>date</span><span class='comma token'>,</span> <span class='percent identifier id'>percent</span><span class='comma token'>,</span> <span class='padded identifier id'>padded</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>"example5.xlsx"</span><span class='rparen token'>)</span> </pre> <p>Validation</p> -<pre class="code"> <span class='id p'>p</span> <span class='op'>=</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id add_worksheet'>add_worksheet</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id sheet'>sheet</span><span class='op'>|</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>First</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Second</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Third</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='int'>1</span><span class='comma'>,</span> <span class='int'>2</span><span class='comma'>,</span> <span class='int'>3</span><span class='rbracket'>]</span> - <span class='kw'>end</span> +<pre class="code"> <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"First"</span><span class='comma token'>,</span> <span class='string val'>"Second"</span><span class='comma token'>,</span> <span class='string val'>"Third"</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>3</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id validate'>validate</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id error'>error</span><span class='op'>|</span> - <span class='id puts'>puts</span> <span class='id error'>error</span><span class='period'>.</span><span class='id inspect'>inspect</span> - <span class='kw'>end</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='error identifier id'>error</span><span class='bitor op'>|</span> + <span class='puts identifier id'>puts</span> <span class='error identifier id'>error</span><span class='dot token'>.</span><span class='inspect identifier id'>inspect</span> + <span class='end end kw'>end</span> </pre> <p>Generating A Line Chart</p> -<pre class="code"> <span class='id p'>p</span> <span class='op'>=</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id add_worksheet'>add_worksheet</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id sheet'>sheet</span><span class='op'>|</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>First</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='int'>1</span><span class='comma'>,</span> <span class='int'>5</span><span class='comma'>,</span> <span class='int'>7</span><span class='comma'>,</span> <span class='int'>9</span><span class='rbracket'>]</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Second</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='int'>5</span><span class='comma'>,</span> <span class='int'>2</span><span class='comma'>,</span> <span class='int'>14</span><span class='comma'>,</span> <span class='int'>9</span><span class='rbracket'>]</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_chart'>add_chart</span><span class='lparen'>(</span><span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Line3DChart</span><span class='comma'>,</span> <span class='symbol'>:title</span><span class='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>example 6: Line Chart</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id chart'>chart</span><span class='op'>|</span> - <span class='id chart'>chart</span><span class='period'>.</span><span class='id start_at'>start_at</span> <span class='int'>0</span><span class='comma'>,</span> <span class='int'>2</span> - <span class='id chart'>chart</span><span class='period'>.</span><span class='id end_at'>end_at</span> <span class='int'>10</span><span class='comma'>,</span> <span class='int'>15</span> - <span class='id chart'>chart</span><span class='period'>.</span><span class='id add_series'>add_series</span> <span class='symbol'>:data</span><span class='op'>=></span><span class='id sheet'>sheet</span><span class='period'>.</span><span class='id rows'>rows</span><span class='period'>.</span><span class='id first'>first</span><span class='period'>.</span><span class='id cells'>cells</span><span class='lbracket'>[</span><span class='lparen'>(</span><span class='int'>1</span><span class='op'>..</span><span class='op'>-</span><span class='int'>1</span><span class='rparen'>)</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:title</span><span class='op'>=></span> <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id rows'>rows</span><span class='period'>.</span><span class='id first'>first</span><span class='period'>.</span><span class='id cells'>cells</span><span class='period'>.</span><span class='id first'>first</span> - <span class='id chart'>chart</span><span class='period'>.</span><span class='id add_series'>add_series</span> <span class='symbol'>:data</span><span class='op'>=></span><span class='id sheet'>sheet</span><span class='period'>.</span><span class='id rows'>rows</span><span class='period'>.</span><span class='id last'>last</span><span class='period'>.</span><span class='id cells'>cells</span><span class='lbracket'>[</span><span class='lparen'>(</span><span class='int'>1</span><span class='op'>..</span><span class='op'>-</span><span class='int'>1</span><span class='rparen'>)</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='symbol'>:title</span><span class='op'>=></span> <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id rows'>rows</span><span class='period'>.</span><span class='id last'>last</span><span class='period'>.</span><span class='id cells'>cells</span><span class='period'>.</span><span class='id first'>first</span> - <span class='kw'>end</span> - - <span class='kw'>end</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id serialize'>serialize</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>example6.xlsx</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> +<pre class="code"> <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"First"</span><span class='comma token'>,</span> <span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>5</span><span class='comma token'>,</span> <span class='integer val'>7</span><span class='comma token'>,</span> <span class='integer val'>9</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"Second"</span><span class='comma token'>,</span> <span class='integer val'>5</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>14</span><span class='comma token'>,</span> <span class='integer val'>9</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Line3DChart constant id'>Line3DChart</span><span class='comma token'>,</span> <span class='symbol val'>:title=</span><span class='gt op'>></span><span class='string val'>"example 6: Line Chart"</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='chart identifier id'>chart</span><span class='bitor op'>|</span> + <span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='start_at identifier id'>start_at</span> <span class='integer val'>0</span><span class='comma token'>,</span> <span class='integer val'>2</span> + <span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='end_at identifier id'>end_at</span> <span class='integer val'>10</span><span class='comma token'>,</span> <span class='integer val'>15</span> + <span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='add_series identifier id'>add_series</span> <span class='symbol val'>:data=</span><span class='gt op'>></span><span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='lbrack token'>[</span><span class='lparen token'>(</span><span class='float val'>1</span><span class='dot2 op'>..</span><span class='integer val'>-1</span><span class='rparen token'>)</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:title=</span><span class='gt op'>></span> <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='first identifier id'>first</span> + <span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='add_series identifier id'>add_series</span> <span class='symbol val'>:data=</span><span class='gt op'>></span><span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='lbrack token'>[</span><span class='lparen token'>(</span><span class='float val'>1</span><span class='dot2 op'>..</span><span class='integer val'>-1</span><span class='rparen token'>)</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:title=</span><span class='gt op'>></span> <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='first identifier id'>first</span> + <span class='end end kw'>end</span> + + <span class='end end kw'>end</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>"example6.xlsx"</span><span class='rparen token'>)</span> </pre> <p>Adding an Image</p> -<pre class="code"> <span class='id p'>p</span> <span class='op'>=</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id add_worksheet'>add_worksheet</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id sheet'>sheet</span><span class='op'>|</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_image'>add_image</span><span class='lparen'>(</span><span class='symbol'>:image_src</span> <span class='op'>=></span> <span class='lparen'>(</span><span class='const'>File</span><span class='period'>.</span><span class='id dirname'>dirname</span><span class='lparen'>(</span><span class='kw'>__FILE__</span><span class='rparen'>)</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/image1.png</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id image'>image</span><span class='op'>|</span> - <span class='id image'>image</span><span class='period'>.</span><span class='id width'>width</span><span class='op'>=</span><span class='int'>720</span> - <span class='id image'>image</span><span class='period'>.</span><span class='id height'>height</span><span class='op'>=</span><span class='int'>666</span> - <span class='id image'>image</span><span class='period'>.</span><span class='id start_at'>start_at</span> <span class='int'>2</span><span class='comma'>,</span> <span class='int'>2</span> - <span class='kw'>end</span> - <span class='kw'>end</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id serialize'>serialize</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>example7.xlsx</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> +<pre class="code"> <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_image identifier id'>add_image</span><span class='lparen token'>(</span><span class='symbol val'>:image_src</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lparen token'>(</span><span class='File constant id'>File</span><span class='dot token'>.</span><span class='dirname identifier id'>dirname</span><span class='lparen token'>(</span><span class='__FILE__ __file__ kw'>__FILE__</span><span class='rparen token'>)</span> <span class='plus op'>+</span> <span class='string val'>"/image1.png"</span><span class='rparen token'>)</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='image identifier id'>image</span><span class='bitor op'>|</span> + <span class='image identifier id'>image</span><span class='dot token'>.</span><span class='width identifier id'>width</span><span class='assign token'>=</span><span class='integer val'>720</span> + <span class='image identifier id'>image</span><span class='dot token'>.</span><span class='height identifier id'>height</span><span class='assign token'>=</span><span class='integer val'>666</span> + <span class='image identifier id'>image</span><span class='dot token'>.</span><span class='start_at identifier id'>start_at</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>2</span> + <span class='end end kw'>end</span> + <span class='end end kw'>end</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>"example7.xlsx"</span><span class='rparen token'>)</span> </pre> <p>Asian Language Support</p> -<pre class="code"> <span class='id p'>p</span> <span class='op'>=</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id add_worksheet'>add_worksheet</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id sheet'>sheet</span><span class='op'>|</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>日本語</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>华语/華語</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>한국어/조선말</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> - <span class='kw'>end</span> - <span class='id p'>p</span><span class='period'>.</span><span class='id serialize'>serialize</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>example8.xlsx</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> +<pre class="code"> <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"日本語"</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"华语/華語"</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"한국어/조선말"</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>"example8.xlsx"</span><span class='rparen token'>)</span> +</pre> + +<p>Styling Columns</p> + +<pre class="code"> <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='percent identifier id'>percent</span> <span class='assign token'>=</span> <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span> <span class='symbol val'>:num_fmt</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='integer val'>9</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>'col 1'</span><span class='comma token'>,</span> <span class='string val'>'col 2'</span><span class='comma token'>,</span> <span class='string val'>'col 3'</span><span class='comma token'>,</span> <span class='string val'>'col 4'</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>0</span><span class='integer val'>.3</span><span class='comma token'>,</span> <span class='integer val'>4</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>0</span><span class='integer val'>.2</span><span class='comma token'>,</span> <span class='integer val'>4</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>0</span><span class='integer val'>.1</span><span class='comma token'>,</span> <span class='integer val'>4</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='worksheets identifier id'>worksheets</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='col_style identifier id'>col_style</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='percent identifier id'>percent</span><span class='comma token'>,</span> <span class='symbol val'>:row_offset=</span><span class='gt op'>></span><span class='integer val'>1</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>"example10.xlsx"</span><span class='rparen token'>)</span> +</pre> + +<p>Styling Rows</p> + +<pre class="code"> <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>'col 1'</span><span class='comma token'>,</span> <span class='string val'>'col 2'</span><span class='comma token'>,</span> <span class='string val'>'col 3'</span><span class='comma token'>,</span> <span class='string val'>'col 4'</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>0</span><span class='integer val'>.3</span><span class='comma token'>,</span> <span class='integer val'>4</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>0</span><span class='integer val'>.2</span><span class='comma token'>,</span> <span class='integer val'>4</span><span class='rbrack token'>]</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>0</span><span class='integer val'>.1</span><span class='comma token'>,</span> <span class='integer val'>4</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> + <span class='head identifier id'>head</span> <span class='assign token'>=</span> <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span> <span class='symbol val'>:bg_color</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"FF000000"</span><span class='comma token'>,</span> <span class='symbol val'>:fg_color=</span><span class='gt op'>></span><span class='string val'>"FFFFFFFF"</span> + <span class='percent identifier id'>percent</span> <span class='assign token'>=</span> <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span> <span class='symbol val'>:num_fmt</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='integer val'>9</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='worksheets identifier id'>worksheets</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='col_style identifier id'>col_style</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='percent identifier id'>percent</span><span class='comma token'>,</span> <span class='symbol val'>:row_offset=</span><span class='gt op'>></span><span class='integer val'>1</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='worksheets identifier id'>worksheets</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='row_style identifier id'>row_style</span> <span class='integer val'>0</span><span class='comma token'>,</span> <span class='head identifier id'>head</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>"example11.xlsx"</span><span class='rparen token'>)</span> +</pre> + +<p>Rails 3</p> + +<pre class="code"> <span class='comment val'># 1. Add the gem to your Gemfile and bundle install</span> + + <span class='gem identifier id'>gem</span> <span class='string val'>'axlsx'</span> + + <span class='comment val'># 2. Add 'acts_as_axslx' to your model</span> + + <span class='class class kw'>class</span> <span class='MyModel constant id'>MyModel</span> <span class='lt op'><</span> <span class='ActiveRecord constant id'>ActiveRecord</span><span class='colon2 op'>::</span><span class='Base constant id'>Base</span> + <span class='acts_as_axlsx identifier id'>acts_as_axlsx</span> + <span class='end end kw'>end</span> + + <span class='comment val'># 3. In your controlle, simply call to_xlsx against the class</span> + + <span class='class class kw'>class</span> <span class='MyModelController constant id'>MyModelController</span> <span class='lt op'><</span> <span class='ApplicationController constant id'>ApplicationController</span> + + <span class='comment val'>#GET /posts/xlsx</span> + <span class='def def kw'>def</span> <span class='xlsx identifier id'>xlsx</span> + <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='MyModel constant id'>MyModel</span><span class='dot token'>.</span><span class='since identifier id'>since</span><span class='lparen token'>(</span><span class='Time constant id'>Time</span><span class='dot token'>.</span><span class='now identifier id'>now</span> <span class='minus op'>-</span> <span class='float val'>5</span><span class='dot token'>.</span><span class='days identifier id'>days</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='to_xlsx identifier id'>to_xlsx</span> + <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>'my_model.xlsx'</span><span class='rparen token'>)</span> + <span class='send_file identifier id'>send_file</span> <span class='string val'>'my_model.xlsx'</span><span class='comma token'>,</span> <span class='symbol val'>:type=</span><span class='gt op'>></span><span class='string val'>"application/xlsx"</span><span class='comma token'>,</span> <span class='symbol val'>:x_sendfile=</span><span class='gt op'>></span><span class='true true kw'>true</span> + <span class='end end kw'>end</span> + <span class='end end kw'>end</span> </pre> <h3>Documentation</h3> <p>This gem is 100% documented with YARD, an exceptional documentation library. To see documentation for this, and all the gems installed on your system use:</p> -<pre class="code"> <span class='id gem'>gem</span> <span class='id install'>install</span> <span class='id yard'>yard</span> - <span class='id yard'>yard</span> <span class='id server'>server</span> <span class='op'>-</span><span class='id g'>g</span> +<pre class="code"> <span class='gem identifier id'>gem</span> <span class='install identifier id'>install</span> <span class='yard identifier id'>yard</span> + <span class='yard identifier id'>yard</span> <span class='server identifier id'>server</span> <span class='minus op'>-</span><span class='g identifier id'>g</span> </pre> <h3>Specs</h3> @@ -238,7 +295,16 @@ With Axlsx you can create worksheets with charts, images, automated column width <h2>Changelog</h2> <ul> -<li><strong>October.26.11</strong>: 1.0.9 release +<li><p><strong>October.27.11</strong>: 1.0.10 release</p> + +<ul> +<li>Updating gemspec to be compatible with rails3 requirements</li> +<li>Added acts_as_xlsx mixin for rails3 See Examples</li> +<li>Added row.style assignation for updating the cell style for an entire row</li> +<li>Added col_style method to worksheet upate a the style for a column of cells</li> +</ul> +</li> +<li><p><strong>October.26.11</strong>: 1.0.9 release</p> <ul> <li>Updated to support ruby 1.9.3</li> @@ -257,9 +323,9 @@ licensed under the MIT license. Please see the <a href="file.LICENSE.html" title </div></div> <div id="footer"> - Generated on Sat Nov 26 13:16:35 2011 by + Generated on Sun Nov 27 18:05:01 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/doc/method_list.html b/doc/method_list.html index db85672c..ff1c4e0d 100644 --- a/doc/method_list.html +++ b/doc/method_list.html @@ -273,17 +273,17 @@ <li class="r2 "> - <span class='object_link'><a href="Axlsx/Row.html#add_cell-instance_method" title="Axlsx::Row#add_cell (method)">#add_cell</a></span> + <span class='object_link'><a href="Axlsx/Ar/ClassMethods.html#acts_as_axlsx-instance_method" title="Axlsx::Ar::ClassMethods#acts_as_axlsx (method)">#acts_as_axlsx</a></span> - <small>Axlsx::Row</small> + <small>Axlsx::Ar::ClassMethods</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Drawing.html#add_chart-instance_method" title="Axlsx::Drawing#add_chart (method)">#add_chart</a></span> + <span class='object_link'><a href="Axlsx/Row.html#add_cell-instance_method" title="Axlsx::Row#add_cell (method)">#add_cell</a></span> - <small>Axlsx::Drawing</small> + <small>Axlsx::Row</small> </li> @@ -297,17 +297,17 @@ <li class="r1 "> - <span class='object_link'><a href="Axlsx/TwoCellAnchor.html#add_chart-instance_method" title="Axlsx::TwoCellAnchor#add_chart (method)">#add_chart</a></span> + <span class='object_link'><a href="Axlsx/Drawing.html#add_chart-instance_method" title="Axlsx::Drawing#add_chart (method)">#add_chart</a></span> - <small>Axlsx::TwoCellAnchor</small> + <small>Axlsx::Drawing</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Worksheet.html#add_image-instance_method" title="Axlsx::Worksheet#add_image (method)">#add_image</a></span> + <span class='object_link'><a href="Axlsx/TwoCellAnchor.html#add_chart-instance_method" title="Axlsx::TwoCellAnchor#add_chart (method)">#add_chart</a></span> - <small>Axlsx::Worksheet</small> + <small>Axlsx::TwoCellAnchor</small> </li> @@ -321,7 +321,7 @@ <li class="r2 "> - <span class='object_link'><a href="Axlsx/Worksheet.html#add_row-instance_method" title="Axlsx::Worksheet#add_row (method)">#add_row</a></span> + <span class='object_link'><a href="Axlsx/Worksheet.html#add_image-instance_method" title="Axlsx::Worksheet#add_image (method)">#add_image</a></span> <small>Axlsx::Worksheet</small> @@ -329,6 +329,14 @@ <li class="r1 "> + <span class='object_link'><a href="Axlsx/Worksheet.html#add_row-instance_method" title="Axlsx::Worksheet#add_row (method)">#add_row</a></span> + + <small>Axlsx::Worksheet</small> + + </li> + + + <li class="r2 "> <span class='object_link'><a href="Axlsx/Chart.html#add_series-instance_method" title="Axlsx::Chart#add_series (method)">#add_series</a></span> <small>Axlsx::Chart</small> @@ -336,7 +344,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/Styles.html#add_style-instance_method" title="Axlsx::Styles#add_style (method)">#add_style</a></span> <small>Axlsx::Styles</small> @@ -344,7 +352,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/Workbook.html#add_worksheet-instance_method" title="Axlsx::Workbook#add_worksheet (method)">#add_worksheet</a></span> <small>Axlsx::Workbook</small> @@ -352,7 +360,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/Xf.html#alignment-instance_method" title="Axlsx::Xf#alignment (method)">#alignment</a></span> <small>Axlsx::Xf</small> @@ -360,6 +368,14 @@ </li> + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Pic.html#anchor-instance_method" title="Axlsx::Pic#anchor (method)">#anchor</a></span> + + <small>Axlsx::Pic</small> + + </li> + + <li class="r1 "> <span class='object_link'><a href="Axlsx/GraphicFrame.html#anchor-instance_method" title="Axlsx::GraphicFrame#anchor (method)">#anchor</a></span> @@ -369,23 +385,23 @@ <li class="r2 "> - <span class='object_link'><a href="Axlsx/Pic.html#anchor-instance_method" title="Axlsx::Pic#anchor (method)">#anchor</a></span> + <span class='object_link'><a href="Axlsx/Drawing.html#anchors-instance_method" title="Axlsx::Drawing#anchors (method)">#anchors</a></span> - <small>Axlsx::Pic</small> + <small>Axlsx::Drawing</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Drawing.html#anchors-instance_method" title="Axlsx::Drawing#anchors (method)">#anchors</a></span> + <span class='object_link'><a href="Axlsx/Xf.html#applyAlignment-instance_method" title="Axlsx::Xf#applyAlignment (method)">#applyAlignment</a></span> - <small>Axlsx::Drawing</small> + <small>Axlsx::Xf</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Xf.html#applyAlignment-instance_method" title="Axlsx::Xf#applyAlignment (method)">#applyAlignment</a></span> + <span class='object_link'><a href="Axlsx/Xf.html#applyBorder-instance_method" title="Axlsx::Xf#applyBorder (method)">#applyBorder</a></span> <small>Axlsx::Xf</small> @@ -393,7 +409,7 @@ <li class="r1 "> - <span class='object_link'><a href="Axlsx/Xf.html#applyBorder-instance_method" title="Axlsx::Xf#applyBorder (method)">#applyBorder</a></span> + <span class='object_link'><a href="Axlsx/Xf.html#applyFill-instance_method" title="Axlsx::Xf#applyFill (method)">#applyFill</a></span> <small>Axlsx::Xf</small> @@ -401,7 +417,7 @@ <li class="r2 "> - <span class='object_link'><a href="Axlsx/Xf.html#applyFill-instance_method" title="Axlsx::Xf#applyFill (method)">#applyFill</a></span> + <span class='object_link'><a href="Axlsx/Xf.html#applyFont-instance_method" title="Axlsx::Xf#applyFont (method)">#applyFont</a></span> <small>Axlsx::Xf</small> @@ -409,7 +425,7 @@ <li class="r1 "> - <span class='object_link'><a href="Axlsx/Xf.html#applyFont-instance_method" title="Axlsx::Xf#applyFont (method)">#applyFont</a></span> + <span class='object_link'><a href="Axlsx/Xf.html#applyNumberFormat-instance_method" title="Axlsx::Xf#applyNumberFormat (method)">#applyNumberFormat</a></span> <small>Axlsx::Xf</small> @@ -417,7 +433,7 @@ <li class="r2 "> - <span class='object_link'><a href="Axlsx/Xf.html#applyNumberFormat-instance_method" title="Axlsx::Xf#applyNumberFormat (method)">#applyNumberFormat</a></span> + <span class='object_link'><a href="Axlsx/Xf.html#applyProtection-instance_method" title="Axlsx::Xf#applyProtection (method)">#applyProtection</a></span> <small>Axlsx::Xf</small> @@ -425,9 +441,9 @@ <li class="r1 "> - <span class='object_link'><a href="Axlsx/Xf.html#applyProtection-instance_method" title="Axlsx::Xf#applyProtection (method)">#applyProtection</a></span> + <span class='object_link'><a href="Axlsx/Color.html#auto-instance_method" title="Axlsx::Color#auto (method)">#auto</a></span> - <small>Axlsx::Xf</small> + <small>Axlsx::Color</small> </li> @@ -441,15 +457,15 @@ <li class="r1 "> - <span class='object_link'><a href="Axlsx/Color.html#auto-instance_method" title="Axlsx::Color#auto (method)">#auto</a></span> + <span class='object_link'><a href="Axlsx/Worksheet.html#auto_fit_data-instance_method" title="Axlsx::Worksheet#auto_fit_data (method)">#auto_fit_data</a></span> - <small>Axlsx::Color</small> + <small>Axlsx::Worksheet</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Worksheet.html#auto_fit_data-instance_method" title="Axlsx::Worksheet#auto_fit_data (method)">#auto_fit_data</a></span> + <span class='object_link'><a href="Axlsx/Worksheet.html#auto_width-instance_method" title="Axlsx::Worksheet#auto_width (method)">#auto_width</a></span> <small>Axlsx::Worksheet</small> @@ -529,6 +545,14 @@ <li class="r2 "> + <span class='object_link'><a href="Axlsx/Cell.html#cast_value-instance_method" title="Axlsx::Cell#cast_value (method)">#cast_value</a></span> + + <small>Axlsx::Cell</small> + + </li> + + + <li class="r1 "> <span class='object_link'><a href="Axlsx/Line3DChart.html#catAxis-instance_method" title="Axlsx::Line3DChart#catAxis (method)">#catAxis</a></span> <small>Axlsx::Line3DChart</small> @@ -536,7 +560,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/Bar3DChart.html#catAxis-instance_method" title="Axlsx::Bar3DChart#catAxis (method)">#catAxis</a></span> <small>Axlsx::Bar3DChart</small> @@ -544,7 +568,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/Title.html#cell-instance_method" title="Axlsx::Title#cell (method)">#cell</a></span> <small>Axlsx::Title</small> @@ -552,7 +576,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/Styles.html#cellStyleXfs-instance_method" title="Axlsx::Styles#cellStyleXfs (method)">#cellStyleXfs</a></span> <small>Axlsx::Styles</small> @@ -560,7 +584,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/Styles.html#cellStyles-instance_method" title="Axlsx::Styles#cellStyles (method)">#cellStyles</a></span> <small>Axlsx::Styles</small> @@ -568,7 +592,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/Styles.html#cellXfs-instance_method" title="Axlsx::Styles#cellXfs (method)">#cellXfs</a></span> <small>Axlsx::Styles</small> @@ -576,7 +600,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx.html#cell_range-class_method" title="Axlsx.cell_range (method)">cell_range</a></span> <small>Axlsx</small> @@ -584,6 +608,14 @@ </li> + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Cell.html#cell_type_from_value-instance_method" title="Axlsx::Cell#cell_type_from_value (method)">#cell_type_from_value</a></span> + + <small>Axlsx::Cell</small> + + </li> + + <li class="r1 "> <span class='object_link'><a href="Axlsx/Row.html#cells-instance_method" title="Axlsx::Row#cells (method)">#cells</a></span> @@ -617,17 +649,17 @@ <li class="r1 "> - <span class='object_link'><a href="Axlsx/Workbook.html#charts-instance_method" title="Axlsx::Workbook#charts (method)">#charts</a></span> + <span class='object_link'><a href="Axlsx/Drawing.html#charts-instance_method" title="Axlsx::Drawing#charts (method)">#charts</a></span> - <small>Axlsx::Workbook</small> + <small>Axlsx::Drawing</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Drawing.html#charts-instance_method" title="Axlsx::Drawing#charts (method)">#charts</a></span> + <span class='object_link'><a href="Axlsx/Workbook.html#charts-instance_method" title="Axlsx::Workbook#charts (method)">#charts</a></span> - <small>Axlsx::Drawing</small> + <small>Axlsx::Workbook</small> </li> @@ -649,17 +681,17 @@ <li class="r1 "> - <span class='object_link'><a href="Axlsx/GradientStop.html#color-instance_method" title="Axlsx::GradientStop#color (method)">#color</a></span> + <span class='object_link'><a href="Axlsx/Cell.html#col_ref-instance_method" title="Axlsx::Cell#col_ref (method)">#col_ref</a></span> - <small>Axlsx::GradientStop</small> + <small>Axlsx::Cell</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Font.html#color-instance_method" title="Axlsx::Font#color (method)">#color</a></span> + <span class='object_link'><a href="Axlsx/Worksheet.html#col_style-instance_method" title="Axlsx::Worksheet#col_style (method)">#col_style</a></span> - <small>Axlsx::Font</small> + <small>Axlsx::Worksheet</small> </li> @@ -673,6 +705,22 @@ <li class="r2 "> + <span class='object_link'><a href="Axlsx/GradientStop.html#color-instance_method" title="Axlsx::GradientStop#color (method)">#color</a></span> + + <small>Axlsx::GradientStop</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Font.html#color-instance_method" title="Axlsx::Font#color (method)">#color</a></span> + + <small>Axlsx::Font</small> + + </li> + + + <li class="r2 "> <span class='object_link'><a href="Axlsx/Font.html#condense-instance_method" title="Axlsx::Font#condense (method)">#condense</a></span> <small>Axlsx::Font</small> @@ -729,25 +777,25 @@ <li class="r1 "> - <span class='object_link'><a href="Axlsx/LineSeries.html#data-instance_method" title="Axlsx::LineSeries#data (method)">#data</a></span> + <span class='object_link'><a href="Axlsx/BarSeries.html#data-instance_method" title="Axlsx::BarSeries#data (method)">#data</a></span> - <small>Axlsx::LineSeries</small> + <small>Axlsx::BarSeries</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/PieSeries.html#data-instance_method" title="Axlsx::PieSeries#data (method)">#data</a></span> + <span class='object_link'><a href="Axlsx/LineSeries.html#data-instance_method" title="Axlsx::LineSeries#data (method)">#data</a></span> - <small>Axlsx::PieSeries</small> + <small>Axlsx::LineSeries</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/BarSeries.html#data-instance_method" title="Axlsx::BarSeries#data (method)">#data</a></span> + <span class='object_link'><a href="Axlsx/PieSeries.html#data-instance_method" title="Axlsx::PieSeries#data (method)">#data</a></span> - <small>Axlsx::BarSeries</small> + <small>Axlsx::PieSeries</small> </li> @@ -769,7 +817,7 @@ <li class="r2 "> - <span class='object_link'><a href="Axlsx/Workbook.html#date1904%3D-class_method" title="Axlsx::Workbook.date1904= (method)">date1904=</a></span> + <span class='object_link'><a href="Axlsx/Workbook.html#date1904%3D-instance_method" title="Axlsx::Workbook#date1904= (method)">#date1904=</a></span> <small>Axlsx::Workbook</small> @@ -777,7 +825,7 @@ <li class="r1 "> - <span class='object_link'><a href="Axlsx/Workbook.html#date1904%3D-instance_method" title="Axlsx::Workbook#date1904= (method)">#date1904=</a></span> + <span class='object_link'><a href="Axlsx/Workbook.html#date1904%3D-class_method" title="Axlsx::Workbook.date1904= (method)">date1904=</a></span> <small>Axlsx::Workbook</small> @@ -849,17 +897,17 @@ <li class="r2 "> - <span class='object_link'><a href="Axlsx/TwoCellAnchor.html#drawing-instance_method" title="Axlsx::TwoCellAnchor#drawing (method)">#drawing</a></span> + <span class='object_link'><a href="Axlsx/OneCellAnchor.html#drawing-instance_method" title="Axlsx::OneCellAnchor#drawing (method)">#drawing</a></span> - <small>Axlsx::TwoCellAnchor</small> + <small>Axlsx::OneCellAnchor</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/OneCellAnchor.html#drawing-instance_method" title="Axlsx::OneCellAnchor#drawing (method)">#drawing</a></span> + <span class='object_link'><a href="Axlsx/TwoCellAnchor.html#drawing-instance_method" title="Axlsx::TwoCellAnchor#drawing (method)">#drawing</a></span> - <small>Axlsx::OneCellAnchor</small> + <small>Axlsx::TwoCellAnchor</small> </li> @@ -1001,41 +1049,41 @@ <li class="r1 "> - <span class='object_link'><a href="Axlsx/Chart.html#from-instance_method" title="Axlsx::Chart#from (method)">#from</a></span> + <span class='object_link'><a href="Axlsx/OneCellAnchor.html#from-instance_method" title="Axlsx::OneCellAnchor#from (method)">#from</a></span> - <small>Axlsx::Chart</small> + <small>Axlsx::OneCellAnchor</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/TwoCellAnchor.html#from-instance_method" title="Axlsx::TwoCellAnchor#from (method)">#from</a></span> + <span class='object_link'><a href="Axlsx/Chart.html#from-instance_method" title="Axlsx::Chart#from (method)">#from</a></span> - <small>Axlsx::TwoCellAnchor</small> + <small>Axlsx::Chart</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/OneCellAnchor.html#from-instance_method" title="Axlsx::OneCellAnchor#from (method)">#from</a></span> + <span class='object_link'><a href="Axlsx/TwoCellAnchor.html#from-instance_method" title="Axlsx::TwoCellAnchor#from (method)">#from</a></span> - <small>Axlsx::OneCellAnchor</small> + <small>Axlsx::TwoCellAnchor</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Bar3DChart.html#gapDepth-instance_method" title="Axlsx::Bar3DChart#gapDepth (method)">#gapDepth</a></span> + <span class='object_link'><a href="Axlsx/Line3DChart.html#gapDepth-instance_method" title="Axlsx::Line3DChart#gapDepth (method)">#gapDepth</a></span> - <small>Axlsx::Bar3DChart</small> + <small>Axlsx::Line3DChart</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Line3DChart.html#gapDepth-instance_method" title="Axlsx::Line3DChart#gapDepth (method)">#gapDepth</a></span> + <span class='object_link'><a href="Axlsx/Bar3DChart.html#gapDepth-instance_method" title="Axlsx::Bar3DChart#gapDepth (method)">#gapDepth</a></span> - <small>Axlsx::Line3DChart</small> + <small>Axlsx::Bar3DChart</small> </li> @@ -1057,17 +1105,17 @@ <li class="r2 "> - <span class='object_link'><a href="Axlsx/Bar3DChart.html#grouping-instance_method" title="Axlsx::Bar3DChart#grouping (method)">#grouping</a></span> + <span class='object_link'><a href="Axlsx/Line3DChart.html#grouping-instance_method" title="Axlsx::Line3DChart#grouping (method)">#grouping</a></span> - <small>Axlsx::Bar3DChart</small> + <small>Axlsx::Line3DChart</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Line3DChart.html#grouping-instance_method" title="Axlsx::Line3DChart#grouping (method)">#grouping</a></span> + <span class='object_link'><a href="Axlsx/Bar3DChart.html#grouping-instance_method" title="Axlsx::Bar3DChart#grouping (method)">#grouping</a></span> - <small>Axlsx::Line3DChart</small> + <small>Axlsx::Bar3DChart</small> </li> @@ -1081,17 +1129,17 @@ <li class="r1 "> - <span class='object_link'><a href="Axlsx/Pic.html#height-instance_method" title="Axlsx::Pic#height (method)">#height</a></span> + <span class='object_link'><a href="Axlsx/OneCellAnchor.html#height-instance_method" title="Axlsx::OneCellAnchor#height (method)">#height</a></span> - <small>Axlsx::Pic</small> + <small>Axlsx::OneCellAnchor</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/OneCellAnchor.html#height-instance_method" title="Axlsx::OneCellAnchor#height (method)">#height</a></span> + <span class='object_link'><a href="Axlsx/Pic.html#height-instance_method" title="Axlsx::Pic#height (method)">#height</a></span> - <small>Axlsx::OneCellAnchor</small> + <small>Axlsx::Pic</small> </li> @@ -1105,17 +1153,17 @@ <li class="r2 "> - <span class='object_link'><a href="Axlsx/CellStyle.html#hidden-instance_method" title="Axlsx::CellStyle#hidden (method)">#hidden</a></span> + <span class='object_link'><a href="Axlsx/CellProtection.html#hidden-instance_method" title="Axlsx::CellProtection#hidden (method)">#hidden</a></span> - <small>Axlsx::CellStyle</small> + <small>Axlsx::CellProtection</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/CellProtection.html#hidden-instance_method" title="Axlsx::CellProtection#hidden (method)">#hidden</a></span> + <span class='object_link'><a href="Axlsx/CellStyle.html#hidden-instance_method" title="Axlsx::CellStyle#hidden (method)">#hidden</a></span> - <small>Axlsx::CellProtection</small> + <small>Axlsx::CellStyle</small> </li> @@ -1153,17 +1201,17 @@ <li class="r2 "> - <span class='object_link'><a href="Axlsx/Drawing.html#images-instance_method" title="Axlsx::Drawing#images (method)">#images</a></span> + <span class='object_link'><a href="Axlsx/Workbook.html#images-instance_method" title="Axlsx::Workbook#images (method)">#images</a></span> - <small>Axlsx::Drawing</small> + <small>Axlsx::Workbook</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Workbook.html#images-instance_method" title="Axlsx::Workbook#images (method)">#images</a></span> + <span class='object_link'><a href="Axlsx/Drawing.html#images-instance_method" title="Axlsx::Drawing#images (method)">#images</a></span> - <small>Axlsx::Workbook</small> + <small>Axlsx::Drawing</small> </li> @@ -1177,25 +1225,25 @@ <li class="r1 "> - <span class='object_link'><a href="Axlsx/Worksheet.html#index-instance_method" title="Axlsx::Worksheet#index (method)">#index</a></span> + <span class='object_link'><a href="Axlsx/Cell.html#index-instance_method" title="Axlsx::Cell#index (method)">#index</a></span> - <small>Axlsx::Worksheet</small> + <small>Axlsx::Cell</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Row.html#index-instance_method" title="Axlsx::Row#index (method)">#index</a></span> + <span class='object_link'><a href="Axlsx/Series.html#index-instance_method" title="Axlsx::Series#index (method)">#index</a></span> - <small>Axlsx::Row</small> + <small>Axlsx::Series</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Series.html#index-instance_method" title="Axlsx::Series#index (method)">#index</a></span> + <span class='object_link'><a href="Axlsx/TwoCellAnchor.html#index-instance_method" title="Axlsx::TwoCellAnchor#index (method)">#index</a></span> - <small>Axlsx::Series</small> + <small>Axlsx::TwoCellAnchor</small> </li> @@ -1209,41 +1257,41 @@ <li class="r1 "> - <span class='object_link'><a href="Axlsx/Cell.html#index-instance_method" title="Axlsx::Cell#index (method)">#index</a></span> + <span class='object_link'><a href="Axlsx/Pic.html#index-instance_method" title="Axlsx::Pic#index (method)">#index</a></span> - <small>Axlsx::Cell</small> + <small>Axlsx::Pic</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/OneCellAnchor.html#index-instance_method" title="Axlsx::OneCellAnchor#index (method)">#index</a></span> + <span class='object_link'><a href="Axlsx/Row.html#index-instance_method" title="Axlsx::Row#index (method)">#index</a></span> - <small>Axlsx::OneCellAnchor</small> + <small>Axlsx::Row</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/TwoCellAnchor.html#index-instance_method" title="Axlsx::TwoCellAnchor#index (method)">#index</a></span> + <span class='object_link'><a href="Axlsx/OneCellAnchor.html#index-instance_method" title="Axlsx::OneCellAnchor#index (method)">#index</a></span> - <small>Axlsx::TwoCellAnchor</small> + <small>Axlsx::OneCellAnchor</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Pic.html#index-instance_method" title="Axlsx::Pic#index (method)">#index</a></span> + <span class='object_link'><a href="Axlsx/Drawing.html#index-instance_method" title="Axlsx::Drawing#index (method)">#index</a></span> - <small>Axlsx::Pic</small> + <small>Axlsx::Drawing</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Drawing.html#index-instance_method" title="Axlsx::Drawing#index (method)">#index</a></span> + <span class='object_link'><a href="Axlsx/Worksheet.html#index-instance_method" title="Axlsx::Worksheet#index (method)">#index</a></span> - <small>Axlsx::Drawing</small> + <small>Axlsx::Worksheet</small> </li> @@ -1257,401 +1305,401 @@ <li class="r1 "> - <span class='object_link'><a href="Axlsx/Font.html#initialize-instance_method" title="Axlsx::Font#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/Scaling.html#initialize-instance_method" title="Axlsx::Scaling#initialize (method)">#initialize</a></span> - <small>Axlsx::Font</small> + <small>Axlsx::Scaling</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Core.html#initialize-instance_method" title="Axlsx::Core#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/Pie3DChart.html#initialize-instance_method" title="Axlsx::Pie3DChart#initialize (method)">#initialize</a></span> - <small>Axlsx::Core</small> + <small>Axlsx::Pie3DChart</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Bar3DChart.html#initialize-instance_method" title="Axlsx::Bar3DChart#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/Font.html#initialize-instance_method" title="Axlsx::Font#initialize (method)">#initialize</a></span> - <small>Axlsx::Bar3DChart</small> + <small>Axlsx::Font</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Override.html#initialize-instance_method" title="Axlsx::Override#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/BorderPr.html#initialize-instance_method" title="Axlsx::BorderPr#initialize (method)">#initialize</a></span> - <small>Axlsx::Override</small> + <small>Axlsx::BorderPr</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/View3D.html#initialize-instance_method" title="Axlsx::View3D#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/Workbook.html#initialize-instance_method" title="Axlsx::Workbook#initialize (method)">#initialize</a></span> - <small>Axlsx::View3D</small> + <small>Axlsx::Workbook</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/CatAxisData.html#initialize-instance_method" title="Axlsx::CatAxisData#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/Override.html#initialize-instance_method" title="Axlsx::Override#initialize (method)">#initialize</a></span> - <small>Axlsx::CatAxisData</small> + <small>Axlsx::Override</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Drawing.html#initialize-instance_method" title="Axlsx::Drawing#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/CatAxis.html#initialize-instance_method" title="Axlsx::CatAxis#initialize (method)">#initialize</a></span> - <small>Axlsx::Drawing</small> + <small>Axlsx::CatAxis</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Xf.html#initialize-instance_method" title="Axlsx::Xf#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/Chart.html#initialize-instance_method" title="Axlsx::Chart#initialize (method)">#initialize</a></span> - <small>Axlsx::Xf</small> + <small>Axlsx::Chart</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/LineSeries.html#initialize-instance_method" title="Axlsx::LineSeries#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/TableStyleElement.html#initialize-instance_method" title="Axlsx::TableStyleElement#initialize (method)">#initialize</a></span> - <small>Axlsx::LineSeries</small> + <small>Axlsx::TableStyleElement</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Axis.html#initialize-instance_method" title="Axlsx::Axis#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/CellStyle.html#initialize-instance_method" title="Axlsx::CellStyle#initialize (method)">#initialize</a></span> - <small>Axlsx::Axis</small> + <small>Axlsx::CellStyle</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/PieSeries.html#initialize-instance_method" title="Axlsx::PieSeries#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/ContentType.html#initialize-instance_method" title="Axlsx::ContentType#initialize (method)">#initialize</a></span> - <small>Axlsx::PieSeries</small> + <small>Axlsx::ContentType</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Title.html#initialize-instance_method" title="Axlsx::Title#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/NumFmt.html#initialize-instance_method" title="Axlsx::NumFmt#initialize (method)">#initialize</a></span> - <small>Axlsx::Title</small> + <small>Axlsx::NumFmt</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/GradientFill.html#initialize-instance_method" title="Axlsx::GradientFill#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/Border.html#initialize-instance_method" title="Axlsx::Border#initialize (method)">#initialize</a></span> - <small>Axlsx::GradientFill</small> + <small>Axlsx::Border</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Scaling.html#initialize-instance_method" title="Axlsx::Scaling#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/BarSeries.html#initialize-instance_method" title="Axlsx::BarSeries#initialize (method)">#initialize</a></span> - <small>Axlsx::Scaling</small> + <small>Axlsx::BarSeries</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Relationships.html#initialize-instance_method" title="Axlsx::Relationships#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/TwoCellAnchor.html#initialize-instance_method" title="Axlsx::TwoCellAnchor#initialize (method)">#initialize</a></span> - <small>Axlsx::Relationships</small> + <small>Axlsx::TwoCellAnchor</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Default.html#initialize-instance_method" title="Axlsx::Default#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/View3D.html#initialize-instance_method" title="Axlsx::View3D#initialize (method)">#initialize</a></span> - <small>Axlsx::Default</small> + <small>Axlsx::View3D</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/BarSeries.html#initialize-instance_method" title="Axlsx::BarSeries#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/Cell.html#initialize-instance_method" title="Axlsx::Cell#initialize (method)">#initialize</a></span> - <small>Axlsx::BarSeries</small> + <small>Axlsx::Cell</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/CellAlignment.html#initialize-instance_method" title="Axlsx::CellAlignment#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/Package.html#initialize-instance_method" title="Axlsx::Package#initialize (method)">#initialize</a></span> - <small>Axlsx::CellAlignment</small> + <small>Axlsx::Package</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/CatAxis.html#initialize-instance_method" title="Axlsx::CatAxis#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/Row.html#initialize-instance_method" title="Axlsx::Row#initialize (method)">#initialize</a></span> - <small>Axlsx::CatAxis</small> + <small>Axlsx::Row</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/NumFmt.html#initialize-instance_method" title="Axlsx::NumFmt#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/GradientFill.html#initialize-instance_method" title="Axlsx::GradientFill#initialize (method)">#initialize</a></span> - <small>Axlsx::NumFmt</small> + <small>Axlsx::GradientFill</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/GradientStop.html#initialize-instance_method" title="Axlsx::GradientStop#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/SerAxis.html#initialize-instance_method" title="Axlsx::SerAxis#initialize (method)">#initialize</a></span> - <small>Axlsx::GradientStop</small> + <small>Axlsx::SerAxis</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Pie3DChart.html#initialize-instance_method" title="Axlsx::Pie3DChart#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/LineSeries.html#initialize-instance_method" title="Axlsx::LineSeries#initialize (method)">#initialize</a></span> - <small>Axlsx::Pie3DChart</small> + <small>Axlsx::LineSeries</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Relationship.html#initialize-instance_method" title="Axlsx::Relationship#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/Marker.html#initialize-instance_method" title="Axlsx::Marker#initialize (method)">#initialize</a></span> - <small>Axlsx::Relationship</small> + <small>Axlsx::Marker</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Color.html#initialize-instance_method" title="Axlsx::Color#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/GraphicFrame.html#initialize-instance_method" title="Axlsx::GraphicFrame#initialize (method)">#initialize</a></span> - <small>Axlsx::Color</small> + <small>Axlsx::GraphicFrame</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/BorderPr.html#initialize-instance_method" title="Axlsx::BorderPr#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/CellProtection.html#initialize-instance_method" title="Axlsx::CellProtection#initialize (method)">#initialize</a></span> - <small>Axlsx::BorderPr</small> + <small>Axlsx::CellProtection</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Pic.html#initialize-instance_method" title="Axlsx::Pic#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/Series.html#initialize-instance_method" title="Axlsx::Series#initialize (method)">#initialize</a></span> - <small>Axlsx::Pic</small> + <small>Axlsx::Series</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Marker.html#initialize-instance_method" title="Axlsx::Marker#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/TableStyle.html#initialize-instance_method" title="Axlsx::TableStyle#initialize (method)">#initialize</a></span> - <small>Axlsx::Marker</small> + <small>Axlsx::TableStyle</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/SerAxis.html#initialize-instance_method" title="Axlsx::SerAxis#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/Title.html#initialize-instance_method" title="Axlsx::Title#initialize (method)">#initialize</a></span> - <small>Axlsx::SerAxis</small> + <small>Axlsx::Title</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Styles.html#initialize-instance_method" title="Axlsx::Styles#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/Line3DChart.html#initialize-instance_method" title="Axlsx::Line3DChart#initialize (method)">#initialize</a></span> - <small>Axlsx::Styles</small> + <small>Axlsx::Line3DChart</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/TableStyles.html#initialize-instance_method" title="Axlsx::TableStyles#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/OneCellAnchor.html#initialize-instance_method" title="Axlsx::OneCellAnchor#initialize (method)">#initialize</a></span> - <small>Axlsx::TableStyles</small> + <small>Axlsx::OneCellAnchor</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/ValAxis.html#initialize-instance_method" title="Axlsx::ValAxis#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/Relationships.html#initialize-instance_method" title="Axlsx::Relationships#initialize (method)">#initialize</a></span> - <small>Axlsx::ValAxis</small> + <small>Axlsx::Relationships</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Cell.html#initialize-instance_method" title="Axlsx::Cell#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/PatternFill.html#initialize-instance_method" title="Axlsx::PatternFill#initialize (method)">#initialize</a></span> - <small>Axlsx::Cell</small> + <small>Axlsx::PatternFill</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/ContentType.html#initialize-instance_method" title="Axlsx::ContentType#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/GradientStop.html#initialize-instance_method" title="Axlsx::GradientStop#initialize (method)">#initialize</a></span> - <small>Axlsx::ContentType</small> + <small>Axlsx::GradientStop</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/GraphicFrame.html#initialize-instance_method" title="Axlsx::GraphicFrame#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/Worksheet.html#initialize-instance_method" title="Axlsx::Worksheet#initialize (method)">#initialize</a></span> - <small>Axlsx::GraphicFrame</small> + <small>Axlsx::Worksheet</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Fill.html#initialize-instance_method" title="Axlsx::Fill#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/Color.html#initialize-instance_method" title="Axlsx::Color#initialize (method)">#initialize</a></span> - <small>Axlsx::Fill</small> + <small>Axlsx::Color</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Worksheet.html#initialize-instance_method" title="Axlsx::Worksheet#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/Fill.html#initialize-instance_method" title="Axlsx::Fill#initialize (method)">#initialize</a></span> - <small>Axlsx::Worksheet</small> + <small>Axlsx::Fill</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Border.html#initialize-instance_method" title="Axlsx::Border#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/CatAxisData.html#initialize-instance_method" title="Axlsx::CatAxisData#initialize (method)">#initialize</a></span> - <small>Axlsx::Border</small> + <small>Axlsx::CatAxisData</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/TableStyleElement.html#initialize-instance_method" title="Axlsx::TableStyleElement#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/Default.html#initialize-instance_method" title="Axlsx::Default#initialize (method)">#initialize</a></span> - <small>Axlsx::TableStyleElement</small> + <small>Axlsx::Default</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Package.html#initialize-instance_method" title="Axlsx::Package#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/TableStyles.html#initialize-instance_method" title="Axlsx::TableStyles#initialize (method)">#initialize</a></span> - <small>Axlsx::Package</small> + <small>Axlsx::TableStyles</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/PatternFill.html#initialize-instance_method" title="Axlsx::PatternFill#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/Relationship.html#initialize-instance_method" title="Axlsx::Relationship#initialize (method)">#initialize</a></span> - <small>Axlsx::PatternFill</small> + <small>Axlsx::Relationship</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/OneCellAnchor.html#initialize-instance_method" title="Axlsx::OneCellAnchor#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/Axis.html#initialize-instance_method" title="Axlsx::Axis#initialize (method)">#initialize</a></span> - <small>Axlsx::OneCellAnchor</small> + <small>Axlsx::Axis</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/TwoCellAnchor.html#initialize-instance_method" title="Axlsx::TwoCellAnchor#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/Styles.html#initialize-instance_method" title="Axlsx::Styles#initialize (method)">#initialize</a></span> - <small>Axlsx::TwoCellAnchor</small> + <small>Axlsx::Styles</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Row.html#initialize-instance_method" title="Axlsx::Row#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/Pic.html#initialize-instance_method" title="Axlsx::Pic#initialize (method)">#initialize</a></span> - <small>Axlsx::Row</small> + <small>Axlsx::Pic</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Workbook.html#initialize-instance_method" title="Axlsx::Workbook#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/PieSeries.html#initialize-instance_method" title="Axlsx::PieSeries#initialize (method)">#initialize</a></span> - <small>Axlsx::Workbook</small> + <small>Axlsx::PieSeries</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Chart.html#initialize-instance_method" title="Axlsx::Chart#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/Xf.html#initialize-instance_method" title="Axlsx::Xf#initialize (method)">#initialize</a></span> - <small>Axlsx::Chart</small> + <small>Axlsx::Xf</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/CellProtection.html#initialize-instance_method" title="Axlsx::CellProtection#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/Bar3DChart.html#initialize-instance_method" title="Axlsx::Bar3DChart#initialize (method)">#initialize</a></span> - <small>Axlsx::CellProtection</small> + <small>Axlsx::Bar3DChart</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Line3DChart.html#initialize-instance_method" title="Axlsx::Line3DChart#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/CellAlignment.html#initialize-instance_method" title="Axlsx::CellAlignment#initialize (method)">#initialize</a></span> - <small>Axlsx::Line3DChart</small> + <small>Axlsx::CellAlignment</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Series.html#initialize-instance_method" title="Axlsx::Series#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/ValAxis.html#initialize-instance_method" title="Axlsx::ValAxis#initialize (method)">#initialize</a></span> - <small>Axlsx::Series</small> + <small>Axlsx::ValAxis</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/TableStyle.html#initialize-instance_method" title="Axlsx::TableStyle#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/Core.html#initialize-instance_method" title="Axlsx::Core#initialize (method)">#initialize</a></span> - <small>Axlsx::TableStyle</small> + <small>Axlsx::Core</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/CellStyle.html#initialize-instance_method" title="Axlsx::CellStyle#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/Drawing.html#initialize-instance_method" title="Axlsx::Drawing#initialize (method)">#initialize</a></span> - <small>Axlsx::CellStyle</small> + <small>Axlsx::Drawing</small> </li> @@ -1673,17 +1721,17 @@ <li class="r1 "> - <span class='object_link'><a href="Axlsx/LineSeries.html#labels-instance_method" title="Axlsx::LineSeries#labels (method)">#labels</a></span> + <span class='object_link'><a href="Axlsx/PieSeries.html#labels-instance_method" title="Axlsx::PieSeries#labels (method)">#labels</a></span> - <small>Axlsx::LineSeries</small> + <small>Axlsx::PieSeries</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/PieSeries.html#labels-instance_method" title="Axlsx::PieSeries#labels (method)">#labels</a></span> + <span class='object_link'><a href="Axlsx/LineSeries.html#labels-instance_method" title="Axlsx::LineSeries#labels (method)">#labels</a></span> - <small>Axlsx::PieSeries</small> + <small>Axlsx::LineSeries</small> </li> @@ -1745,65 +1793,65 @@ <li class="r2 "> - <span class='object_link'><a href="Axlsx/Worksheet.html#name-instance_method" title="Axlsx::Worksheet#name (method)">#name</a></span> + <span class='object_link'><a href="Axlsx/TableStyle.html#name-instance_method" title="Axlsx::TableStyle#name (method)">#name</a></span> - <small>Axlsx::Worksheet</small> + <small>Axlsx::TableStyle</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Pic.html#name-instance_method" title="Axlsx::Pic#name (method)">#name</a></span> + <span class='object_link'><a href="Axlsx/Font.html#name-instance_method" title="Axlsx::Font#name (method)">#name</a></span> - <small>Axlsx::Pic</small> + <small>Axlsx::Font</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Font.html#name-instance_method" title="Axlsx::Font#name (method)">#name</a></span> + <span class='object_link'><a href="Axlsx/Worksheet.html#name-instance_method" title="Axlsx::Worksheet#name (method)">#name</a></span> - <small>Axlsx::Font</small> + <small>Axlsx::Worksheet</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/CellStyle.html#name-instance_method" title="Axlsx::CellStyle#name (method)">#name</a></span> + <span class='object_link'><a href="Axlsx/BorderPr.html#name-instance_method" title="Axlsx::BorderPr#name (method)">#name</a></span> - <small>Axlsx::CellStyle</small> + <small>Axlsx::BorderPr</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/BorderPr.html#name-instance_method" title="Axlsx::BorderPr#name (method)">#name</a></span> + <span class='object_link'><a href="Axlsx/CellStyle.html#name-instance_method" title="Axlsx::CellStyle#name (method)">#name</a></span> - <small>Axlsx::BorderPr</small> + <small>Axlsx::CellStyle</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/TableStyle.html#name-instance_method" title="Axlsx::TableStyle#name (method)">#name</a></span> + <span class='object_link'><a href="Axlsx/Pic.html#name-instance_method" title="Axlsx::Pic#name (method)">#name</a></span> - <small>Axlsx::TableStyle</small> + <small>Axlsx::Pic</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/NumFmt.html#numFmtId-instance_method" title="Axlsx::NumFmt#numFmtId (method)">#numFmtId</a></span> + <span class='object_link'><a href="Axlsx/Xf.html#numFmtId-instance_method" title="Axlsx::Xf#numFmtId (method)">#numFmtId</a></span> - <small>Axlsx::NumFmt</small> + <small>Axlsx::Xf</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Xf.html#numFmtId-instance_method" title="Axlsx::Xf#numFmtId (method)">#numFmtId</a></span> + <span class='object_link'><a href="Axlsx/NumFmt.html#numFmtId-instance_method" title="Axlsx::NumFmt#numFmtId (method)">#numFmtId</a></span> - <small>Axlsx::Xf</small> + <small>Axlsx::NumFmt</small> </li> @@ -1817,17 +1865,17 @@ <li class="r1 "> - <span class='object_link'><a href="Axlsx/OneCellAnchor.html#object-instance_method" title="Axlsx::OneCellAnchor#object (method)">#object</a></span> + <span class='object_link'><a href="Axlsx/TwoCellAnchor.html#object-instance_method" title="Axlsx::TwoCellAnchor#object (method)">#object</a></span> - <small>Axlsx::OneCellAnchor</small> + <small>Axlsx::TwoCellAnchor</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/TwoCellAnchor.html#object-instance_method" title="Axlsx::TwoCellAnchor#object (method)">#object</a></span> + <span class='object_link'><a href="Axlsx/OneCellAnchor.html#object-instance_method" title="Axlsx::OneCellAnchor#object (method)">#object</a></span> - <small>Axlsx::TwoCellAnchor</small> + <small>Axlsx::OneCellAnchor</small> </li> @@ -1857,17 +1905,17 @@ <li class="r2 "> - <span class='object_link'><a href="Axlsx/Font.html#outline-instance_method" title="Axlsx::Font#outline (method)">#outline</a></span> + <span class='object_link'><a href="Axlsx/Border.html#outline-instance_method" title="Axlsx::Border#outline (method)">#outline</a></span> - <small>Axlsx::Font</small> + <small>Axlsx::Border</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Border.html#outline-instance_method" title="Axlsx::Border#outline (method)">#outline</a></span> + <span class='object_link'><a href="Axlsx/Font.html#outline-instance_method" title="Axlsx::Font#outline (method)">#outline</a></span> - <small>Axlsx::Border</small> + <small>Axlsx::Font</small> </li> @@ -1905,17 +1953,17 @@ <li class="r2 "> - <span class='object_link'><a href="Axlsx/Pic.html#pn-instance_method" title="Axlsx::Pic#pn (method)">#pn</a></span> + <span class='object_link'><a href="Axlsx/Chart.html#pn-instance_method" title="Axlsx::Chart#pn (method)">#pn</a></span> - <small>Axlsx::Pic</small> + <small>Axlsx::Chart</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Chart.html#pn-instance_method" title="Axlsx::Chart#pn (method)">#pn</a></span> + <span class='object_link'><a href="Axlsx/Pic.html#pn-instance_method" title="Axlsx::Pic#pn (method)">#pn</a></span> - <small>Axlsx::Chart</small> + <small>Axlsx::Pic</small> </li> @@ -1985,9 +2033,9 @@ <li class="r2 "> - <span class='object_link'><a href="Axlsx/Worksheet.html#rId-instance_method" title="Axlsx::Worksheet#rId (method)">#rId</a></span> + <span class='object_link'><a href="Axlsx/Drawing.html#rId-instance_method" title="Axlsx::Drawing#rId (method)">#rId</a></span> - <small>Axlsx::Worksheet</small> + <small>Axlsx::Drawing</small> </li> @@ -2001,9 +2049,9 @@ <li class="r2 "> - <span class='object_link'><a href="Axlsx/Drawing.html#rId-instance_method" title="Axlsx::Drawing#rId (method)">#rId</a></span> + <span class='object_link'><a href="Axlsx/Worksheet.html#rId-instance_method" title="Axlsx::Worksheet#rId (method)">#rId</a></span> - <small>Axlsx::Drawing</small> + <small>Axlsx::Worksheet</small> </li> @@ -2025,25 +2073,25 @@ <li class="r1 "> - <span class='object_link'><a href="Axlsx/Worksheet.html#relationships-instance_method" title="Axlsx::Worksheet#relationships (method)">#relationships</a></span> + <span class='object_link'><a href="Axlsx/Workbook.html#relationships-instance_method" title="Axlsx::Workbook#relationships (method)">#relationships</a></span> - <small>Axlsx::Worksheet</small> + <small>Axlsx::Workbook</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Workbook.html#relationships-instance_method" title="Axlsx::Workbook#relationships (method)">#relationships</a></span> + <span class='object_link'><a href="Axlsx/Drawing.html#relationships-instance_method" title="Axlsx::Drawing#relationships (method)">#relationships</a></span> - <small>Axlsx::Workbook</small> + <small>Axlsx::Drawing</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Drawing.html#relationships-instance_method" title="Axlsx::Drawing#relationships (method)">#relationships</a></span> + <span class='object_link'><a href="Axlsx/Worksheet.html#relationships-instance_method" title="Axlsx::Worksheet#relationships (method)">#relationships</a></span> - <small>Axlsx::Drawing</small> + <small>Axlsx::Worksheet</small> </li> @@ -2057,17 +2105,17 @@ <li class="r1 "> - <span class='object_link'><a href="Axlsx/Worksheet.html#rels_pn-instance_method" title="Axlsx::Worksheet#rels_pn (method)">#rels_pn</a></span> + <span class='object_link'><a href="Axlsx/Drawing.html#rels_pn-instance_method" title="Axlsx::Drawing#rels_pn (method)">#rels_pn</a></span> - <small>Axlsx::Worksheet</small> + <small>Axlsx::Drawing</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Drawing.html#rels_pn-instance_method" title="Axlsx::Drawing#rels_pn (method)">#rels_pn</a></span> + <span class='object_link'><a href="Axlsx/Worksheet.html#rels_pn-instance_method" title="Axlsx::Worksheet#rels_pn (method)">#rels_pn</a></span> - <small>Axlsx::Drawing</small> + <small>Axlsx::Worksheet</small> </li> @@ -2129,6 +2177,14 @@ <li class="r2 "> + <span class='object_link'><a href="Axlsx/Worksheet.html#row_style-instance_method" title="Axlsx::Worksheet#row_style (method)">#row_style</a></span> + + <small>Axlsx::Worksheet</small> + + </li> + + + <li class="r1 "> <span class='object_link'><a href="Axlsx/Worksheet.html#rows-instance_method" title="Axlsx::Worksheet#rows (method)">#rows</a></span> <small>Axlsx::Worksheet</small> @@ -2136,6 +2192,14 @@ </li> + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Package.html#ruport_table-instance_method" title="Axlsx::Package#ruport_table (method)">#ruport_table</a></span> + + <small>Axlsx::Package</small> + + </li> + + <li class="r1 "> <span class='object_link'><a href="Axlsx/Axis.html#scaling-instance_method" title="Axlsx::Axis#scaling (method)">#scaling</a></span> @@ -2257,17 +2321,17 @@ <li class="r2 "> - <span class='object_link'><a href="Axlsx/Chart.html#style-instance_method" title="Axlsx::Chart#style (method)">#style</a></span> + <span class='object_link'><a href="Axlsx/BorderPr.html#style-instance_method" title="Axlsx::BorderPr#style (method)">#style</a></span> - <small>Axlsx::Chart</small> + <small>Axlsx::BorderPr</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/BorderPr.html#style-instance_method" title="Axlsx::BorderPr#style (method)">#style</a></span> + <span class='object_link'><a href="Axlsx/Chart.html#style-instance_method" title="Axlsx::Chart#style (method)">#style</a></span> - <small>Axlsx::BorderPr</small> + <small>Axlsx::Chart</small> </li> @@ -2281,6 +2345,14 @@ <li class="r1 "> + <span class='object_link'><a href="Axlsx/Row.html#style%3D-instance_method" title="Axlsx::Row#style= (method)">#style=</a></span> + + <small>Axlsx::Row</small> + + </li> + + + <li class="r2 "> <span class='object_link'><a href="Axlsx/Workbook.html#styles-instance_method" title="Axlsx::Workbook#styles (method)">#styles</a></span> <small>Axlsx::Workbook</small> @@ -2288,7 +2360,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/Font.html#sz-instance_method" title="Axlsx::Font#sz (method)">#sz</a></span> <small>Axlsx::Font</small> @@ -2296,7 +2368,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/TableStyle.html#table-instance_method" title="Axlsx::TableStyle#table (method)">#table</a></span> <small>Axlsx::TableStyle</small> @@ -2304,7 +2376,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/Styles.html#tableStyles-instance_method" title="Axlsx::Styles#tableStyles (method)">#tableStyles</a></span> <small>Axlsx::Styles</small> @@ -2312,7 +2384,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/Title.html#text-instance_method" title="Axlsx::Title#text (method)">#text</a></span> <small>Axlsx::Title</small> @@ -2320,7 +2392,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/CellAlignment.html#textRotation-instance_method" title="Axlsx::CellAlignment#textRotation (method)">#textRotation</a></span> <small>Axlsx::CellAlignment</small> @@ -2328,7 +2400,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/Axis.html#tickLblPos-instance_method" title="Axlsx::Axis#tickLblPos (method)">#tickLblPos</a></span> <small>Axlsx::Axis</small> @@ -2336,7 +2408,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/SerAxis.html#tickLblSkip-instance_method" title="Axlsx::SerAxis#tickLblSkip (method)">#tickLblSkip</a></span> <small>Axlsx::SerAxis</small> @@ -2344,7 +2416,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/SerAxis.html#tickMarkSkip-instance_method" title="Axlsx::SerAxis#tickMarkSkip (method)">#tickMarkSkip</a></span> <small>Axlsx::SerAxis</small> @@ -2352,7 +2424,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/Color.html#tint-instance_method" title="Axlsx::Color#tint (method)">#tint</a></span> <small>Axlsx::Color</small> @@ -2360,14 +2432,6 @@ </li> - <li class="r1 "> - <span class='object_link'><a href="Axlsx/Chart.html#title-instance_method" title="Axlsx::Chart#title (method)">#title</a></span> - - <small>Axlsx::Chart</small> - - </li> - - <li class="r2 "> <span class='object_link'><a href="Axlsx/Series.html#title-instance_method" title="Axlsx::Series#title (method)">#title</a></span> @@ -2377,7 +2441,7 @@ <li class="r1 "> - <span class='object_link'><a href="Axlsx/Chart.html#to-instance_method" title="Axlsx::Chart#to (method)">#to</a></span> + <span class='object_link'><a href="Axlsx/Chart.html#title-instance_method" title="Axlsx::Chart#title (method)">#title</a></span> <small>Axlsx::Chart</small> @@ -2393,57 +2457,57 @@ <li class="r1 "> - <span class='object_link'><a href="Axlsx/Workbook.html#to_xml-instance_method" title="Axlsx::Workbook#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/Chart.html#to-instance_method" title="Axlsx::Chart#to (method)">#to</a></span> - <small>Axlsx::Workbook</small> + <small>Axlsx::Chart</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/TableStyleElement.html#to_xml-instance_method" title="Axlsx::TableStyleElement#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/Ar/SingletonMethods.html#to_xlsx-instance_method" title="Axlsx::Ar::SingletonMethods#to_xlsx (method)">#to_xlsx</a></span> - <small>Axlsx::TableStyleElement</small> + <small>Axlsx::Ar::SingletonMethods</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Marker.html#to_xml-instance_method" title="Axlsx::Marker#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/CatAxisData.html#to_xml-instance_method" title="Axlsx::CatAxisData#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Marker</small> + <small>Axlsx::CatAxisData</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/TableStyle.html#to_xml-instance_method" title="Axlsx::TableStyle#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/GradientFill.html#to_xml-instance_method" title="Axlsx::GradientFill#to_xml (method)">#to_xml</a></span> - <small>Axlsx::TableStyle</small> + <small>Axlsx::GradientFill</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/CellStyle.html#to_xml-instance_method" title="Axlsx::CellStyle#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/GraphicFrame.html#to_xml-instance_method" title="Axlsx::GraphicFrame#to_xml (method)">#to_xml</a></span> - <small>Axlsx::CellStyle</small> + <small>Axlsx::GraphicFrame</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Font.html#to_xml-instance_method" title="Axlsx::Font#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/TableStyleElement.html#to_xml-instance_method" title="Axlsx::TableStyleElement#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Font</small> + <small>Axlsx::TableStyleElement</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Border.html#to_xml-instance_method" title="Axlsx::Border#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/Relationship.html#to_xml-instance_method" title="Axlsx::Relationship#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Border</small> + <small>Axlsx::Relationship</small> </li> @@ -2457,33 +2521,33 @@ <li class="r1 "> - <span class='object_link'><a href="Axlsx/CatAxisData.html#to_xml-instance_method" title="Axlsx::CatAxisData#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/TableStyle.html#to_xml-instance_method" title="Axlsx::TableStyle#to_xml (method)">#to_xml</a></span> - <small>Axlsx::CatAxisData</small> + <small>Axlsx::TableStyle</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Override.html#to_xml-instance_method" title="Axlsx::Override#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/CatAxis.html#to_xml-instance_method" title="Axlsx::CatAxis#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Override</small> + <small>Axlsx::CatAxis</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/View3D.html#to_xml-instance_method" title="Axlsx::View3D#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/Scaling.html#to_xml-instance_method" title="Axlsx::Scaling#to_xml (method)">#to_xml</a></span> - <small>Axlsx::View3D</small> + <small>Axlsx::Scaling</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/OneCellAnchor.html#to_xml-instance_method" title="Axlsx::OneCellAnchor#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/GradientStop.html#to_xml-instance_method" title="Axlsx::GradientStop#to_xml (method)">#to_xml</a></span> - <small>Axlsx::OneCellAnchor</small> + <small>Axlsx::GradientStop</small> </li> @@ -2497,254 +2561,262 @@ <li class="r2 "> - <span class='object_link'><a href="Axlsx/Xf.html#to_xml-instance_method" title="Axlsx::Xf#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/Cell.html#to_xml-instance_method" title="Axlsx::Cell#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Xf</small> + <small>Axlsx::Cell</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/ValAxis.html#to_xml-instance_method" title="Axlsx::ValAxis#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/Line3DChart.html#to_xml-instance_method" title="Axlsx::Line3DChart#to_xml (method)">#to_xml</a></span> - <small>Axlsx::ValAxis</small> + <small>Axlsx::Line3DChart</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/TableStyles.html#to_xml-instance_method" title="Axlsx::TableStyles#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/Override.html#to_xml-instance_method" title="Axlsx::Override#to_xml (method)">#to_xml</a></span> - <small>Axlsx::TableStyles</small> + <small>Axlsx::Override</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Line3DChart.html#to_xml-instance_method" title="Axlsx::Line3DChart#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/TableStyles.html#to_xml-instance_method" title="Axlsx::TableStyles#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Line3DChart</small> + <small>Axlsx::TableStyles</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/SerAxis.html#to_xml-instance_method" title="Axlsx::SerAxis#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/App.html#to_xml-instance_method" title="Axlsx::App#to_xml (method)">#to_xml</a></span> - <small>Axlsx::SerAxis</small> + <small>Axlsx::App</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Styles.html#to_xml-instance_method" title="Axlsx::Styles#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/BorderPr.html#to_xml-instance_method" title="Axlsx::BorderPr#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Styles</small> + <small>Axlsx::BorderPr</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Color.html#to_xml-instance_method" title="Axlsx::Color#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/Chart.html#to_xml-instance_method" title="Axlsx::Chart#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Color</small> + <small>Axlsx::Chart</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Drawing.html#to_xml-instance_method" title="Axlsx::Drawing#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/SeriesTitle.html#to_xml-instance_method" title="Axlsx::SeriesTitle#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Drawing</small> + <small>Axlsx::SeriesTitle</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Relationship.html#to_xml-instance_method" title="Axlsx::Relationship#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/OneCellAnchor.html#to_xml-instance_method" title="Axlsx::OneCellAnchor#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Relationship</small> + <small>Axlsx::OneCellAnchor</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/GraphicFrame.html#to_xml-instance_method" title="Axlsx::GraphicFrame#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/Relationships.html#to_xml-instance_method" title="Axlsx::Relationships#to_xml (method)">#to_xml</a></span> - <small>Axlsx::GraphicFrame</small> + <small>Axlsx::Relationships</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Fill.html#to_xml-instance_method" title="Axlsx::Fill#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/Series.html#to_xml-instance_method" title="Axlsx::Series#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Fill</small> + <small>Axlsx::Series</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Cell.html#to_xml-instance_method" title="Axlsx::Cell#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/CellStyle.html#to_xml-instance_method" title="Axlsx::CellStyle#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Cell</small> + <small>Axlsx::CellStyle</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/CatAxis.html#to_xml-instance_method" title="Axlsx::CatAxis#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/ValAxisData.html#to_xml-instance_method" title="Axlsx::ValAxisData#to_xml (method)">#to_xml</a></span> - <small>Axlsx::CatAxis</small> + <small>Axlsx::ValAxisData</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/NumFmt.html#to_xml-instance_method" title="Axlsx::NumFmt#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/Workbook.html#to_xml-instance_method" title="Axlsx::Workbook#to_xml (method)">#to_xml</a></span> - <small>Axlsx::NumFmt</small> + <small>Axlsx::Workbook</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/ValAxisData.html#to_xml-instance_method" title="Axlsx::ValAxisData#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/Drawing.html#to_xml-instance_method" title="Axlsx::Drawing#to_xml (method)">#to_xml</a></span> - <small>Axlsx::ValAxisData</small> + <small>Axlsx::Drawing</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Pie3DChart.html#to_xml-instance_method" title="Axlsx::Pie3DChart#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/ContentType.html#to_xml-instance_method" title="Axlsx::ContentType#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Pie3DChart</small> + <small>Axlsx::ContentType</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/BarSeries.html#to_xml-instance_method" title="Axlsx::BarSeries#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/CellProtection.html#to_xml-instance_method" title="Axlsx::CellProtection#to_xml (method)">#to_xml</a></span> - <small>Axlsx::BarSeries</small> + <small>Axlsx::CellProtection</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Chart.html#to_xml-instance_method" title="Axlsx::Chart#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/Styles.html#to_xml-instance_method" title="Axlsx::Styles#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Chart</small> + <small>Axlsx::Styles</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/SeriesTitle.html#to_xml-instance_method" title="Axlsx::SeriesTitle#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/SerAxis.html#to_xml-instance_method" title="Axlsx::SerAxis#to_xml (method)">#to_xml</a></span> - <small>Axlsx::SeriesTitle</small> + <small>Axlsx::SerAxis</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/TwoCellAnchor.html#to_xml-instance_method" title="Axlsx::TwoCellAnchor#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/Default.html#to_xml-instance_method" title="Axlsx::Default#to_xml (method)">#to_xml</a></span> - <small>Axlsx::TwoCellAnchor</small> + <small>Axlsx::Default</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Default.html#to_xml-instance_method" title="Axlsx::Default#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/TwoCellAnchor.html#to_xml-instance_method" title="Axlsx::TwoCellAnchor#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Default</small> + <small>Axlsx::TwoCellAnchor</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Scaling.html#to_xml-instance_method" title="Axlsx::Scaling#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/NumFmt.html#to_xml-instance_method" title="Axlsx::NumFmt#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Scaling</small> + <small>Axlsx::NumFmt</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/CellProtection.html#to_xml-instance_method" title="Axlsx::CellProtection#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/ValAxis.html#to_xml-instance_method" title="Axlsx::ValAxis#to_xml (method)">#to_xml</a></span> - <small>Axlsx::CellProtection</small> + <small>Axlsx::ValAxis</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Pic.html#to_xml-instance_method" title="Axlsx::Pic#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/PatternFill.html#to_xml-instance_method" title="Axlsx::PatternFill#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Pic</small> + <small>Axlsx::PatternFill</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/PatternFill.html#to_xml-instance_method" title="Axlsx::PatternFill#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/Xf.html#to_xml-instance_method" title="Axlsx::Xf#to_xml (method)">#to_xml</a></span> - <small>Axlsx::PatternFill</small> + <small>Axlsx::Xf</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/BorderPr.html#to_xml-instance_method" title="Axlsx::BorderPr#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/Fill.html#to_xml-instance_method" title="Axlsx::Fill#to_xml (method)">#to_xml</a></span> - <small>Axlsx::BorderPr</small> + <small>Axlsx::Fill</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/GradientFill.html#to_xml-instance_method" title="Axlsx::GradientFill#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/Marker.html#to_xml-instance_method" title="Axlsx::Marker#to_xml (method)">#to_xml</a></span> - <small>Axlsx::GradientFill</small> + <small>Axlsx::Marker</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/PieSeries.html#to_xml-instance_method" title="Axlsx::PieSeries#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/Color.html#to_xml-instance_method" title="Axlsx::Color#to_xml (method)">#to_xml</a></span> - <small>Axlsx::PieSeries</small> + <small>Axlsx::Color</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/GradientStop.html#to_xml-instance_method" title="Axlsx::GradientStop#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/LineSeries.html#to_xml-instance_method" title="Axlsx::LineSeries#to_xml (method)">#to_xml</a></span> - <small>Axlsx::GradientStop</small> + <small>Axlsx::LineSeries</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/ContentType.html#to_xml-instance_method" title="Axlsx::ContentType#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/Border.html#to_xml-instance_method" title="Axlsx::Border#to_xml (method)">#to_xml</a></span> - <small>Axlsx::ContentType</small> + <small>Axlsx::Border</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Row.html#to_xml-instance_method" title="Axlsx::Row#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/Pie3DChart.html#to_xml-instance_method" title="Axlsx::Pie3DChart#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Row</small> + <small>Axlsx::Pie3DChart</small> </li> <li class="r1 "> + <span class='object_link'><a href="Axlsx/CellAlignment.html#to_xml-instance_method" title="Axlsx::CellAlignment#to_xml (method)">#to_xml</a></span> + + <small>Axlsx::CellAlignment</small> + + </li> + + + <li class="r2 "> <span class='object_link'><a href="Axlsx/Bar3DChart.html#to_xml-instance_method" title="Axlsx::Bar3DChart#to_xml (method)">#to_xml</a></span> <small>Axlsx::Bar3DChart</small> @@ -2752,10 +2824,18 @@ </li> + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Title.html#to_xml-instance_method" title="Axlsx::Title#to_xml (method)">#to_xml</a></span> + + <small>Axlsx::Title</small> + + </li> + + <li class="r2 "> - <span class='object_link'><a href="Axlsx/CellAlignment.html#to_xml-instance_method" title="Axlsx::CellAlignment#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/Pic.html#to_xml-instance_method" title="Axlsx::Pic#to_xml (method)">#to_xml</a></span> - <small>Axlsx::CellAlignment</small> + <small>Axlsx::Pic</small> </li> @@ -2769,38 +2849,46 @@ <li class="r2 "> - <span class='object_link'><a href="Axlsx/LineSeries.html#to_xml-instance_method" title="Axlsx::LineSeries#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/Font.html#to_xml-instance_method" title="Axlsx::Font#to_xml (method)">#to_xml</a></span> - <small>Axlsx::LineSeries</small> + <small>Axlsx::Font</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/App.html#to_xml-instance_method" title="Axlsx::App#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/PieSeries.html#to_xml-instance_method" title="Axlsx::PieSeries#to_xml (method)">#to_xml</a></span> - <small>Axlsx::App</small> + <small>Axlsx::PieSeries</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Title.html#to_xml-instance_method" title="Axlsx::Title#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/View3D.html#to_xml-instance_method" title="Axlsx::View3D#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Title</small> + <small>Axlsx::View3D</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Relationships.html#to_xml-instance_method" title="Axlsx::Relationships#to_xml (method)">#to_xml</a></span> + <span class='object_link'><a href="Axlsx/Row.html#to_xml-instance_method" title="Axlsx::Row#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Relationships</small> + <small>Axlsx::Row</small> </li> <li class="r2 "> + <span class='object_link'><a href="Axlsx/BarSeries.html#to_xml-instance_method" title="Axlsx::BarSeries#to_xml (method)">#to_xml</a></span> + + <small>Axlsx::BarSeries</small> + + </li> + + + <li class="r1 "> <span class='object_link'><a href="Axlsx/GradientFill.html#top-instance_method" title="Axlsx::GradientFill#top (method)">#top</a></span> <small>Axlsx::GradientFill</small> @@ -2808,6 +2896,14 @@ </li> + <li class="r2 "> + <span class='object_link'><a href="Axlsx/TableStyleElement.html#type-instance_method" title="Axlsx::TableStyleElement#type (method)">#type</a></span> + + <small>Axlsx::TableStyleElement</small> + + </li> + + <li class="r1 "> <span class='object_link'><a href="Axlsx/GradientFill.html#type-instance_method" title="Axlsx::GradientFill#type (method)">#type</a></span> @@ -2825,57 +2921,57 @@ <li class="r1 "> - <span class='object_link'><a href="Axlsx/TableStyleElement.html#type-instance_method" title="Axlsx::TableStyleElement#type (method)">#type</a></span> + <span class='object_link'><a href="Axlsx/Worksheet.html#update_auto_fit_data-instance_method" title="Axlsx::Worksheet#update_auto_fit_data (method)">#update_auto_fit_data</a></span> - <small>Axlsx::TableStyleElement</small> + <small>Axlsx::Worksheet</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Line3DChart.html#valAxis-instance_method" title="Axlsx::Line3DChart#valAxis (method)">#valAxis</a></span> + <span class='object_link'><a href="Axlsx/Bar3DChart.html#valAxis-instance_method" title="Axlsx::Bar3DChart#valAxis (method)">#valAxis</a></span> - <small>Axlsx::Line3DChart</small> + <small>Axlsx::Bar3DChart</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Bar3DChart.html#valAxis-instance_method" title="Axlsx::Bar3DChart#valAxis (method)">#valAxis</a></span> + <span class='object_link'><a href="Axlsx/Line3DChart.html#valAxis-instance_method" title="Axlsx::Line3DChart#valAxis (method)">#valAxis</a></span> - <small>Axlsx::Bar3DChart</small> + <small>Axlsx::Line3DChart</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Package.html#validate-instance_method" title="Axlsx::Package#validate (method)">#validate</a></span> + <span class='object_link'><a href="Axlsx/RegexValidator.html#validate-class_method" title="Axlsx::RegexValidator.validate (method)">validate</a></span> - <small>Axlsx::Package</small> + <small>Axlsx::RegexValidator</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/DataTypeValidator.html#validate-class_method" title="Axlsx::DataTypeValidator.validate (method)">validate</a></span> + <span class='object_link'><a href="Axlsx/Package.html#validate-instance_method" title="Axlsx::Package#validate (method)">#validate</a></span> - <small>Axlsx::DataTypeValidator</small> + <small>Axlsx::Package</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/RegexValidator.html#validate-class_method" title="Axlsx::RegexValidator.validate (method)">validate</a></span> + <span class='object_link'><a href="Axlsx/RestrictionValidator.html#validate-class_method" title="Axlsx::RestrictionValidator.validate (method)">validate</a></span> - <small>Axlsx::RegexValidator</small> + <small>Axlsx::RestrictionValidator</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/RestrictionValidator.html#validate-class_method" title="Axlsx::RestrictionValidator.validate (method)">validate</a></span> + <span class='object_link'><a href="Axlsx/DataTypeValidator.html#validate-class_method" title="Axlsx::DataTypeValidator.validate (method)">validate</a></span> - <small>Axlsx::RestrictionValidator</small> + <small>Axlsx::DataTypeValidator</small> </li> @@ -3025,17 +3121,17 @@ <li class="r2 "> - <span class='object_link'><a href="Axlsx/Package.html#workbook-instance_method" title="Axlsx::Package#workbook (method)">#workbook</a></span> + <span class='object_link'><a href="Axlsx/Worksheet.html#workbook-instance_method" title="Axlsx::Worksheet#workbook (method)">#workbook</a></span> - <small>Axlsx::Package</small> + <small>Axlsx::Worksheet</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Worksheet.html#workbook-instance_method" title="Axlsx::Worksheet#workbook (method)">#workbook</a></span> + <span class='object_link'><a href="Axlsx/Package.html#workbook-instance_method" title="Axlsx::Package#workbook (method)">#workbook</a></span> - <small>Axlsx::Worksheet</small> + <small>Axlsx::Package</small> </li> @@ -3081,17 +3177,17 @@ <li class="r1 "> - <span class='object_link'><a href="Axlsx/CellStyle.html#xfId-instance_method" title="Axlsx::CellStyle#xfId (method)">#xfId</a></span> + <span class='object_link'><a href="Axlsx/Xf.html#xfId-instance_method" title="Axlsx::Xf#xfId (method)">#xfId</a></span> - <small>Axlsx::CellStyle</small> + <small>Axlsx::Xf</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Xf.html#xfId-instance_method" title="Axlsx::Xf#xfId (method)">#xfId</a></span> + <span class='object_link'><a href="Axlsx/CellStyle.html#xfId-instance_method" title="Axlsx::CellStyle#xfId (method)">#xfId</a></span> - <small>Axlsx::Xf</small> + <small>Axlsx::CellStyle</small> </li> diff --git a/doc/top-level-namespace.html b/doc/top-level-namespace.html index 548df99e..e1066280 100644 --- a/doc/top-level-namespace.html +++ b/doc/top-level-namespace.html @@ -94,9 +94,9 @@ </div> <div id="footer"> - Generated on Sat Nov 26 13:16:40 2011 by + Generated on Sun Nov 27 18:05:21 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> diff --git a/examples/example.rb b/examples/example.rb index e8869f75..747c34ee 100644 --- a/examples/example.rb +++ b/examples/example.rb @@ -1,19 +1,20 @@ +#!/usr/bin/env ruby # -*- coding: utf-8 -*- -# encoding: utf-8 require 'rubygems' require 'axlsx' #A Simple Workbook - +if ARGV.size == 0 || ARGV.include?("1") p = Axlsx::Package.new p.workbook.add_worksheet do |sheet| sheet.add_row ["First", "Second", "Third"] sheet.add_row [1, 2, 3] end p.serialize("example1.xlsx") - +end #Generating A Bar Chart +if ARGV.size==0 || ARGV.include?("2") p = Axlsx::Package.new p.workbook.add_worksheet do |sheet| @@ -24,8 +25,9 @@ end end p.serialize("example2.xlsx") - +end #Generating A Pie Chart +if ARGV.size==0 || ARGV.include?("3") p = Axlsx::Package.new p.workbook.add_worksheet do |sheet| @@ -36,9 +38,10 @@ end end p.serialize("example3.xlsx") - +end #Using Custom Styles +if ARGV.size==0 || ARGV.include?("4") p = Axlsx::Package.new wb = p.workbook @@ -49,8 +52,9 @@ sheet.add_row [1, 2, 3], :style => Axlsx::STYLE_THIN_BORDER end p.serialize("example4.xlsx") - +end #Using Custom Formatting and date1904 +if ARGV.size==0 || ARGV.include?("5") p = Axlsx::Package.new wb = p.workbook @@ -63,8 +67,9 @@ sheet.add_row [Time.now, 0.2, 32], :style => [date, percent, padded] end p.serialize("example5.xlsx") - +end #Validation +if ARGV.size==0 || ARGV.include?("6") p = Axlsx::Package.new p.workbook.add_worksheet do |sheet| @@ -75,8 +80,9 @@ p.validate.each do |error| puts error.inspect end - +end #Generating A Line Chart +if ARGV.size==0 || ARGV.include?("7") p = Axlsx::Package.new p.workbook.add_worksheet do |sheet| @@ -90,9 +96,10 @@ end end - p.serialize("example6.xlsx") - + p.serialize("example7.xlsx") +end #Add an Image +if ARGV.size==0 || ARGV.include?("8") p = Axlsx::Package.new p.workbook.add_worksheet do |sheet| @@ -103,10 +110,11 @@ image.start_at 2, 2 end end - p.serialize("example7.xlsx") - + p.serialize("example8.xlsx") +end #Asian Language Support +if ARGV.size==0 || ARGV.include?("9") p = Axlsx::Package.new p.workbook.add_worksheet do |sheet| @@ -114,5 +122,54 @@ sheet.add_row ["华语/華語"] sheet.add_row ["한국어/조선말"] end - p.serialize("example8.xlsx") + p.serialize("example9.xlsx") +end + + +#Styling Columns +if ARGV.size==0 || ARGV.include?("10") + p = Axlsx::Package.new + percent = p.workbook.styles.add_style :num_fmt => 9 + p.workbook.add_worksheet do |sheet| + sheet.add_row ['col 1', 'col 2', 'col 3', 'col 4'] + sheet.add_row [1, 2, 0.3, 4] + sheet.add_row [1, 2, 0.2, 4] + sheet.add_row [1, 2, 0.1, 4] + end + p.workbook.worksheets.first.col_style 2, percent, :row_offset=>1 + p.serialize("example10.xlsx") +end + +#Styling Rows +if ARGV.size==0 || ARGV.include?("11") + p = Axlsx::Package.new + p.workbook.add_worksheet do |sheet| + sheet.add_row ['col 1', 'col 2', 'col 3', 'col 4'] + sheet.add_row [1, 2, 0.3, 4] + sheet.add_row [1, 2, 0.2, 4] + sheet.add_row [1, 2, 0.1, 4] + end + head = p.workbook.styles.add_style :bg_color => "FF000000", :fg_color=>"FFFFFFFF" + percent = p.workbook.styles.add_style :num_fmt => 9 + p.workbook.worksheets.first.col_style 2, percent, :row_offset=>1 + p.workbook.worksheets.first.row_style 0, head + p.serialize("example11.xlsx") +end + +#Rails 3 + + # class MyModel < ActiveRecord::Base + # acts_as_axlsx + # end + # + # class MyModelController < ApplicationController + # + # GET /posts/xlsx + # def xlsx + # p = Post.to_xlsx + # p.serialize('posts.xlsx') + # send_file 'posts.xlsx', :type=>"application/xlsx", :x_sendfile=>true + # end + + diff --git a/lib/axlsx.rb b/lib/axlsx.rb index aee52b36..0a84a7e1 100644 --- a/lib/axlsx.rb +++ b/lib/axlsx.rb @@ -16,6 +16,7 @@ require 'axlsx/drawing/drawing.rb' require 'axlsx/workbook/workbook.rb' require 'axlsx/package.rb' +require 'axlsx/ar.rb' #required gems diff --git a/lib/axlsx/ar.rb b/lib/axlsx/ar.rb new file mode 100644 index 00000000..2864c95a --- /dev/null +++ b/lib/axlsx/ar.rb @@ -0,0 +1,60 @@ +# ActsAsAxlsx +require 'axlsx' +module Axlsx + + module Ar + + def self.included(base) + base.send :extend, ClassMethods + end + + module ClassMethods + + # we should do what ruport did and use only, exclude and methods hashes + def acts_as_axlsx(options={}) + include Axlsx::Ar::InstanceMethods + extend Axlsx::Ar::SingletonMethods + end + end + + module SingletonMethods + + def to_xlsx(number = :all, options = {}) + row_style = options.delete(:style) + header_style = options.delete(:header_style) || row_style + types = options.delete(:types) + + data = [*find(number, options)] + data.compact! + data.flatten! + columns = data.first.attributes.keys + p = Package.new + row_style = p.workbook.styles.add_style(row_style) unless row_style.nil? + header_style = p.workbook.styles.add_style(header_style) unless header_style.nil? + + p.workbook.add_worksheet(:name=>table_name.humanize) do |sheet| + sheet.add_row columns, :style=>header_style + data.each do |r| + sheet.add_row r.attributes.values, :style=>row_style, :types=>types + end + end + p + end + + end + + module InstanceMethods + end + + + end + +end +begin +require 'active_record' +ActiveRecord::Base.send :include, Axlsx::Ar +rescue Exception=>e + puts "Running without active record extensions" +end + + diff --git a/lib/axlsx/package.rb b/lib/axlsx/package.rb index d9455f14..921646da 100644 --- a/lib/axlsx/package.rb +++ b/lib/axlsx/package.rb @@ -15,7 +15,12 @@ module Axlsx @core.creator = options[:author] || @core.creator yield self if block_given? end - + + # Accepts a ruport table for serialization to xlsx + # @param [Table] table a ruport Table object + def ruport_table(table) + puts table + end # The workbook this package will serialize or validate. # @return [Workbook] If no workbook instance has been assigned with this package a new Workbook instance is returned. diff --git a/lib/axlsx/version.rb b/lib/axlsx/version.rb index 2ecaf2a9..92993f79 100644 --- a/lib/axlsx/version.rb +++ b/lib/axlsx/version.rb @@ -1,4 +1,4 @@ module Axlsx # version - VERSION="1.0.9" + VERSION="1.0.10" end diff --git a/lib/axlsx/workbook/worksheet/row.rb b/lib/axlsx/workbook/worksheet/row.rb index 96a1c3d1..442dcf7b 100644 --- a/lib/axlsx/workbook/worksheet/row.rb +++ b/lib/axlsx/workbook/worksheet/row.rb @@ -54,6 +54,13 @@ module Axlsx c end + # sets the style for every cell in this row + def style=(style) + cells.each_with_index do | cell, index | + s = style.is_a?(Array) ? style[index] : style + cell.style = s + end + end private diff --git a/lib/axlsx/workbook/worksheet/worksheet.rb b/lib/axlsx/workbook/worksheet/worksheet.rb index 6dfbc060..65f620e4 100644 --- a/lib/axlsx/workbook/worksheet/worksheet.rb +++ b/lib/axlsx/workbook/worksheet/worksheet.rb @@ -89,6 +89,33 @@ module Axlsx @rows.last end + # Set the style for cells in a specific row + # @param [Integer] index the index of the row + # @param [Integer] the cellXfs index + # @option options [Integer] col_offset only cells after this column will be updated. + # @note You can also specify the style in the add_row call + # @see Worksheet#add_row + # @see README.md for an example + def row_style(index, style, options={}) + raise ArgumentError, "Invalid Row Index" unless index < @rows.size + offset = options.delete(:col_offset) || 0 + @rows[index].cells[(offset..-1)].each { |c| c.style = style } + end + + + # Set the style for cells in a specific column + # @param [Integer] index the index of the column + # @param [Integer] the cellXfs index + # @option options [Integer] row_offset only cells after this column will be updated. + # @note You can also specify the style for specific columns in the call to add_row by using an array for the :styles option + # @see Worksheet#add_row + # @see README.md for an example + def col_style(index, style, options={}) + raise ArgumentError, "Invalid Column Index" unless index < @rows.first.cells.size + offset = options.delete(:row_offset) || 0 + @rows[(offset..-1)].each { |r| r.cells[index].style = style } + end + # Adds a chart to this worksheets drawing. This is the recommended way to create charts for your worksheet. This method wraps the complexity of dealing with ooxml drawing, anchors, markers graphic frames chart objects and all the other dirty details. # @param [Class] chart_type # @option options [Array] start_at @@ -183,7 +210,7 @@ module Axlsx # From ECMA docs # Column width measured as the number of characters of the maximum digit width of the numbers 0 .. 9 as # rendered in the normal style's font. There are 4 pixels of margin padding (two on each side), plus 1 pixel padding for the gridlines. - # width = Truncate([!{Number of Characters} * !{Maximum Digit Width} + !{5 pixel padding}]/!{Maximum Digit Width}*256)/256 + # width = Truncate([!{Number of Characters} * !{Maximum Digit Width} + !{5 pixel padding}]/{Maximum Digit Width}*256)/256 # @return [Float] # @param [Hash] A hash of auto_fit_data def auto_width(col) diff --git a/test/workbook/worksheet/tc_row.rb b/test/workbook/worksheet/tc_row.rb index 5dfdc601..f9b589e3 100644 --- a/test/workbook/worksheet/tc_row.rb +++ b/test/workbook/worksheet/tc_row.rb @@ -14,6 +14,12 @@ class TestRow < Test::Unit::TestCase assert_equal(@row.worksheet, @ws, "has a reference to the worksheet") end + def test_style + r = @ws.add_row([1,2,3,4,5]) + r.style=1 + r.cells.each { |c| assert_equal(c.style,1) } + end + def test_index assert_equal(@row.index, @row.worksheet.rows.index(@row)) end diff --git a/test/workbook/worksheet/tc_worksheet.rb b/test/workbook/worksheet/tc_worksheet.rb index ce913778..6bdf5f20 100644 --- a/test/workbook/worksheet/tc_worksheet.rb +++ b/test/workbook/worksheet/tc_worksheet.rb @@ -46,6 +46,31 @@ class TestWorksheet < Test::Unit::TestCase assert @ws.drawing.is_a? Axlsx::Drawing end + def test_col_style + @ws.add_row [1,2,3,4] + @ws.add_row [1,2,3,4] + @ws.add_row [1,2,3,4] + @ws.add_row [1,2,3,4] + @ws.col_style 1, 1, :row_offset=>1 + @ws.rows[(1..-1)].each do | r | + assert_equal(r.cells[1].style, 1) + end + assert_equal(@ws.rows.first.cells[1].style, 0) + assert_equal(@ws.rows.first.cells[0].style, 0) + end + + def test_row_style + @ws.add_row [1,2,3,4] + @ws.add_row [1,2,3,4] + @ws.add_row [1,2,3,4] + @ws.add_row [1,2,3,4] + @ws.row_style 1, 1, :col_offset=>1 + @ws.rows[1].cells[(1..-1)].each do | c | + assert_equal(c.style, 1) + end + assert_equal(@ws.rows[1].cells[0].style, 0) + assert_equal(@ws.rows[2].cells[1].style, 0) + end def test_to_xml schema = Nokogiri::XML::Schema(File.open(Axlsx::SML_XSD)) |