diff options
94 files changed, 4849 insertions, 817 deletions
diff --git a/.yardoc/checksums b/.yardoc/checksums index 4281ee7b..ef718f71 100644 --- a/.yardoc/checksums +++ b/.yardoc/checksums @@ -1,56 +1,58 @@ lib/axlsx/stylesheet/table_styles.rb 04b778652c29d612f63e93080d06c3936e48d765 lib/axlsx/stylesheet/table_style.rb b592135b8b02969a29bd24c28a13282f6af76f30 -lib/axlsx/drawing/pie_3D_chart.rb 9370e48b73000c96ebd50712dc4b4a958ad8527d +lib/axlsx/drawing/pie_3D_chart.rb f9c70bd12b697dcd51780f29c037d4659b48e479 lib/axlsx/stylesheet/border_pr.rb 09dcb61ec7b0cf49f2da4c4f8ccba8f7e0df7b07 lib/axlsx/stylesheet/color.rb 4927aaebe27dda42d78bb7baf9a44edc1753c77f +lib/axlsx/util/constants.rb 4dc8b1d765aa0593615a14c3761b0183be308908 lib/axlsx/drawing/marker.rb 3507738522c02a3733a01f115d9ef22fae4ea542 -lib/axlsx/util/constants.rb 20e4a98177305d407b77eb62f0bca5ecc29b234c lib/axlsx/stylesheet/cell_protection.rb ce494f9add6de0a51407ddd9122fffe95759a48a lib/axlsx/stylesheet/cell_style.rb 46c6ff183bce5c6b1ab6228823257d638007b03c lib/axlsx/drawing/series_title.rb 8f088942649b5b5cc351b621bf8fb252f33cb510 -lib/axlsx/drawing/line_series.rb ada7cbca0d561c2e2f6bad56c1eb5d8ea2c1f071 +lib/axlsx/drawing/line_series.rb ffcd6d010ea0606f54a543eb1fc61022aac129d7 lib/axlsx/drawing/series.rb 1cf010706e32e7e51affbc9edb9d4862a26b33ef -lib/axlsx/package.rb eea7499e09e0936eeb8e08d10823f05990722023 +lib/axlsx/package.rb 339a8e5650f45623b126efddd22d3a5f0655aad9 lib/axlsx/stylesheet/cell_alignment.rb f67f6a0bc16bf13669ed7b18714e4de23825ed94 lib/axlsx/content_type/default.rb 8ec0d9d1e6bf261735739823acd460c271e3f5ed lib/axlsx/drawing/title.rb b46fb082e3bea936d129c8aa0998f3b71c9838cc lib/axlsx/drawing/axis.rb 5e37bac9f4dd258265213d5621522eed3c614954 lib/axlsx/stylesheet/table_style_element.rb bee66d743e3113fb14adc7ebdecbeb606bfb49fc lib/axlsx/content_type/content_type.rb 6c576e1618f99f7163fffa6b6e89e964653dcb5f -lib/axlsx/stylesheet/num_fmt.rb dc830c6540465afa824881efa2f1ce4070957c47 lib/axlsx/rels/relationships.rb 9c741e180796259bb378a789fd484fa1d8f04425 +lib/axlsx/stylesheet/num_fmt.rb dc830c6540465afa824881efa2f1ce4070957c47 lib/axlsx.rb 7d8c589a0bdc16acf8774ae1b77d5177b030a80c -lib/axlsx/drawing/graphic_frame.rb 43496359fac0e990ded62f04254232f3cec8f736 lib/axlsx/content_type/override.rb 72245683bca868f181d709a515f9152485653229 +lib/axlsx/drawing/graphic_frame.rb 9fb4e59405ea7974e9759906efd5c8c90dfa9b89 lib/axlsx/drawing/pie_series.rb df339ed3eeb5692077e3a134339d04e77c9bc89b -lib/axlsx/drawing/bar_series.rb 044a3c42d3781755012c863ca138257b85ff5c0a +lib/axlsx/drawing/bar_series.rb 76d41efe347318587a932f9313f03e0a76abb4ee lib/axlsx/stylesheet/gradient_fill.rb 5fd260ec2b94ab75a970159035528548a9d21cd6 lib/axlsx/workbook/worksheet/row.rb f866a98341ce4e604908e42d00f2af09e58c75d2 lib/axlsx/util/simple_typed_list.rb b95f7e8d8958361cb1946b8545126b9384ff9fd2 -lib/axlsx/workbook/workbook.rb ec98ed826e6c3ca9c6e3303dbfbe00c0b5fb9aee +lib/axlsx/workbook/workbook.rb 12c82a584a9bfc4dfbb92c04426413d7eb44a504 lib/axlsx/stylesheet/fill.rb 35966285f5d759d63451005ceae3a5ae5ba2ceca lib/axlsx/drawing/view_3D.rb c8e25d57901dd7d679fe7d1ed674d5549ab6f1b3 lib/axlsx/stylesheet/xf.rb e3d6e2e4c3b0b33c91de4c3db16c73aca3db4473 -lib/axlsx/drawing/two_cell_anchor.rb a9400212ca7ed64263fd77826c3d336115cae185 +lib/axlsx/drawing/two_cell_anchor.rb b89873e55820f9be35f8e5ebe22bd8a0d319622a lib/axlsx/stylesheet/styles.rb 3679a8fe86270bdef96f02bcf76f2eac27b1c2ef lib/axlsx/drawing/val_axis.rb da067622f8b09e6caf5067955b277d75ab3c8943 lib/axlsx/drawing/cat_axis.rb f046262d1e8d04ff697fe29b88725225cd406cb2 -lib/axlsx/util/validators.rb 2320eee50ceee29cc0dbab95721a6c633dc660e1 +lib/axlsx/util/validators.rb 11eb309df0232fc1ad36c8c5ab0804d656b2294a lib/axlsx/stylesheet/font.rb 8b002d5fcba2fb0979858517f5254aadf96c7e58 lib/axlsx/doc_props/app.rb 52f01e985a33253987177798d4e79ed208649b30 -lib/axlsx/workbook/worksheet/worksheet.rb ba299b3a4f1e82f7da4fb6e28fad264dd6e2fbed +lib/axlsx/workbook/worksheet/worksheet.rb c7159356776e5ca1cfb6d0bc288c3acf278226c8 lib/axlsx/workbook/worksheet/cell.rb 939623ffc2065e9ec26bc56d9e289d9137fe57d3 -lib/axlsx/rels/relationship.rb a160c998acf7fd0ab8195ea6162b1eb2eab4963c +lib/axlsx/rels/relationship.rb 067b924c964a870124d51ea6e39dc1cd8983db21 lib/axlsx/stylesheet/border.rb 517bfcb43380919ce7abef494d5d3e50911b7c19 lib/axlsx/drawing/ser_axis.rb 6d15f6cc2092ef5c3baa314ed1af793247418d9b -lib/axlsx/drawing/drawing.rb a5d71d9c7e86f15fdea03754ab258009035151dd -lib/axlsx/drawing/chart.rb 2907d74c75580cd5f029a71140a750d4e69c869e -lib/axlsx/version.rb eb4274097b7f8f3f60e4e3dd8d57fb6bf6148f36 +lib/axlsx/drawing/drawing.rb 243992f4dd131092c6981b3b8cb68905c55d7e1e +lib/axlsx/drawing/chart.rb b0bfdd0cc2f0f48ed3ddcf2a1b1c46c5d9cabc2e +lib/axlsx/version.rb ff68edc0a9bdaaaa00a81a27a3de4fa8fe4e70ce lib/axlsx/stylesheet/gradient_stop.rb de34e289aeccb4abd9a3b7e60e816a0b12ffacff -lib/axlsx/drawing/cat_axis_data.rb efc95067f90bf8d0bb4ce0fa6e35b7b9d642e8b5 +lib/axlsx/drawing/cat_axis_data.rb f440010084afad99d97d31354f5b5a8ee8766e9b lib/axlsx/drawing/val_axis_data.rb c57c0abf5abb4aca9fba774f20e2f2c04d3020e8 lib/axlsx/doc_props/core.rb 90ebc8086f6606af02275c27068c359a5647faf0 +lib/axlsx/drawing/pic.rb b728be1f2f927e02c08b55c7a03b8bc6059f8672 lib/axlsx/drawing/bar_3D_chart.rb e5199cf0a33e416ea5ddf66677031ee08e5c116f lib/axlsx/drawing/scaling.rb d3b59eed1897dc2b07bb41b2245c6e4b3e274d7e lib/axlsx/stylesheet/pattern_fill.rb 817cf55beb3db160b2b56edb6c94de1ecf1ecee7 +lib/axlsx/drawing/one_cell_anchor.rb 512f300984cc9b2c4db73afb967b445d2e240ab7 lib/axlsx/drawing/line_3D_chart.rb de0a2c8a49259e0348fd2c642c08eb4c567bcf1b diff --git a/.yardoc/objects/root.dat b/.yardoc/objects/root.dat Binary files differindex 489afdf0..0646be52 100644 --- a/.yardoc/objects/root.dat +++ b/.yardoc/objects/root.dat @@ -1,4 +1,4 @@ --protected --no-private -CHANGELOG.md -LICENSE +--title "AXLSX" +LICENSE CHANGELOG.md @@ -6,7 +6,7 @@ Axlsx: Office Open XML Spreadsheet Generation **Author**: Randy Morgan **Copyright**: 2011 **License**: MIT License -**Latest Version**: 1.0.7 +**Latest Version**: 1.0.8 **Ruby Version**: 1.8.7 **Release Date**: November 23nd 2011 @@ -14,7 +14,7 @@ Synopsis -------- Axlsx is an Office Open XML Spreadsheet generator for the Ruby programming language. -It enables the you to generate 100% valid xlsx files that include customised styling 3D pie, bar and line charts. Below is a summary of salient features. +It enables the you to generate 100% valid xlsx files that include customised styling, images, 3D pie, bar and line charts and auto-width columns. Below is a summary of salient features. Feature List ------------ @@ -31,6 +31,7 @@ Feature List **6. Support for both 1904 and 1900 epocs configurable in the workbook. +**7. Add jpg, gif and png images to worksheets Installing ---------- @@ -134,6 +135,17 @@ Generating A Line Chart end p.serialize("example6.xlsx") +Adding an Image + + p = Axlsx::Package.new + p.workbook.add_worksheet do |sheet| + sheet.add_image(:image_src => (File.dirname(__FILE__) + "/image1.png")) do |image| + image.width=720 + image.height=666 + image.start_at 2, 2 + end + end + p.serialize("example7.xlsx") ###Documentation @@ -149,6 +161,8 @@ This gem has 100% test coverage using test/unit. To execute tests for this gem, Changelog --------- +- **October.23.11**: 1.0.8 release + - Added support for images (jpg, gif, png) in worksheets. - **October.23.11**: 1.0.7 released - Added support for 3D options when creating a new chart. This lets you set the persective, rotation and other 3D attributes when using worksheet.add_chart @@ -163,6 +177,10 @@ Changelog Please see the {file:CHANGELOG.md} document for past release information. +Help Wanted +----------- + +I'd really like to get rid of the depenency on RMagick in this gem. RMagic is being used to calculate the column widths in a worksheet based on the content the user specified. If there happens to be anyone out there with the background and skill set to write an extenstion that can determine the width of a singel character render with a specific font at a specific size please give me a shout. Copyright --------- diff --git a/doc/Axlsx.html b/doc/Axlsx.html index 2a8b517f..8fde8b4d 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/package.rb<span class="defines">,<br /> - lib/axlsx.rb,<br /> lib/axlsx/version.rb,<br /> lib/axlsx/drawing/axis.rb,<br /> lib/axlsx/doc_props/app.rb,<br /> lib/axlsx/drawing/title.rb,<br /> lib/axlsx/stylesheet/xf.rb,<br /> lib/axlsx/drawing/chart.rb,<br /> lib/axlsx/drawing/series.rb,<br /> lib/axlsx/util/constants.rb,<br /> lib/axlsx/drawing/marker.rb,<br /> lib/axlsx/doc_props/core.rb,<br /> lib/axlsx/drawing/view_3D.rb,<br /> lib/axlsx/stylesheet/font.rb,<br /> lib/axlsx/drawing/drawing.rb,<br /> lib/axlsx/util/validators.rb,<br /> lib/axlsx/drawing/scaling.rb,<br /> lib/axlsx/stylesheet/fill.rb,<br /> lib/axlsx/stylesheet/color.rb,<br /> lib/axlsx/drawing/ser_axis.rb,<br /> lib/axlsx/drawing/cat_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/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/stylesheet/border_pr.rb,<br /> lib/axlsx/drawing/series_title.rb,<br /> lib/axlsx/content_type/default.rb,<br /> lib/axlsx/drawing/bar_3D_chart.rb,<br /> lib/axlsx/drawing/pie_3D_chart.rb,<br /> lib/axlsx/drawing/line_3D_chart.rb,<br /> lib/axlsx/stylesheet/cell_style.rb,<br /> lib/axlsx/drawing/val_axis_data.rb,<br /> lib/axlsx/content_type/override.rb,<br /> lib/axlsx/drawing/cat_axis_data.rb,<br /> lib/axlsx/drawing/graphic_frame.rb,<br /> lib/axlsx/util/simple_typed_list.rb,<br /> lib/axlsx/stylesheet/table_style.rb,<br /> lib/axlsx/workbook/worksheet/row.rb,<br /> lib/axlsx/stylesheet/table_styles.rb,<br /> lib/axlsx/drawing/two_cell_anchor.rb,<br /> lib/axlsx/workbook/worksheet/cell.rb,<br /> lib/axlsx/stylesheet/pattern_fill.rb,<br /> lib/axlsx/stylesheet/gradient_fill.rb,<br /> lib/axlsx/stylesheet/gradient_stop.rb,<br /> lib/axlsx/content_type/content_type.rb,<br /> lib/axlsx/stylesheet/cell_alignment.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.rb,<br /> lib/axlsx/version.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> </dd> </dl> @@ -98,7 +98,7 @@ cell styles, automatically resized column widths and 3D pie charts. - <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/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/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/SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</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> + <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/SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</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> </p> @@ -122,7 +122,7 @@ version </div> </dt> - <dd><pre class="code"><span class='string val'>"1.0.7"</span> + <dd><pre class="code"><span class='string val'>"1.0.8"</span> </pre></dd> <dt id="ENCODING-constant" class="">ENCODING = @@ -539,6 +539,24 @@ chart rels namespace <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> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <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"> @@ -719,6 +737,60 @@ chart content type <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> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <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> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <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> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <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"> @@ -755,6 +827,60 @@ xml content type extensions <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> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <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> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <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> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <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"> @@ -989,6 +1115,24 @@ chart part <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> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <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"> @@ -1743,7 +1887,7 @@ The value validated <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 114</span> <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='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='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> @@ -2126,7 +2270,7 @@ The value validated <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 121</span> <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='rbrack token'>]</span><span class='comma token'>,</span> <span class='v identifier id'>v</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> @@ -2434,7 +2578,7 @@ The value validated </div> <div id="footer"> - Generated on Wed Nov 23 12:36:29 2011 by + Generated on Wed Nov 23 21:44:35 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> diff --git a/doc/Axlsx/App.html b/doc/Axlsx/App.html index c7e072d2..90816fde 100644 --- a/doc/Axlsx/App.html +++ b/doc/Axlsx/App.html @@ -2631,7 +2631,7 @@ The document as a string </div> <div id="footer"> - Generated on Wed Nov 23 12:36:48 2011 by + Generated on Wed Nov 23 21:44:50 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> diff --git a/doc/Axlsx/Axis.html b/doc/Axlsx/Axis.html index f999a62c..5d2cfb3a 100644 --- a/doc/Axlsx/Axis.html +++ b/doc/Axlsx/Axis.html @@ -1064,7 +1064,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:46 2011 by + Generated on Wed Nov 23 21:44:41 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> diff --git a/doc/Axlsx/Bar3DChart.html b/doc/Axlsx/Bar3DChart.html index adc2e51e..5c6ba596 100644 --- a/doc/Axlsx/Bar3DChart.html +++ b/doc/Axlsx/Bar3DChart.html @@ -1171,7 +1171,7 @@ Serializes the bar chart </div> <div id="footer"> - Generated on Wed Nov 23 12:36:33 2011 by + Generated on Wed Nov 23 21:44:41 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> diff --git a/doc/Axlsx/BarSeries.html b/doc/Axlsx/BarSeries.html index 6528def1..287b4f9d 100644 --- a/doc/Axlsx/BarSeries.html +++ b/doc/Axlsx/BarSeries.html @@ -697,7 +697,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:26 2011 by + Generated on Wed Nov 23 21:44:40 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> diff --git a/doc/Axlsx/Border.html b/doc/Axlsx/Border.html index 259897a0..49db8f1b 100644 --- a/doc/Axlsx/Border.html +++ b/doc/Axlsx/Border.html @@ -766,7 +766,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:38 2011 by + Generated on Wed Nov 23 21:44:49 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> diff --git a/doc/Axlsx/BorderPr.html b/doc/Axlsx/BorderPr.html index e199b368..1f0f3d86 100644 --- a/doc/Axlsx/BorderPr.html +++ b/doc/Axlsx/BorderPr.html @@ -700,7 +700,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:38 2011 by + Generated on Wed Nov 23 21:44:42 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> diff --git a/doc/Axlsx/CatAxis.html b/doc/Axlsx/CatAxis.html index 4f5b14cf..e12cfcf2 100644 --- a/doc/Axlsx/CatAxis.html +++ b/doc/Axlsx/CatAxis.html @@ -760,7 +760,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:43 2011 by + Generated on Wed Nov 23 21:44:44 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> diff --git a/doc/Axlsx/CatAxisData.html b/doc/Axlsx/CatAxisData.html index 46378225..8fb3726a 100644 --- a/doc/Axlsx/CatAxisData.html +++ b/doc/Axlsx/CatAxisData.html @@ -253,7 +253,8 @@ typed list of cells. 7 8 9 -10</pre> +10 +11</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis_data.rb', line 7</span> @@ -261,6 +262,7 @@ typed list of cells. <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> @@ -344,7 +346,6 @@ The document builder instance this objects xml will be added to. <pre class="lines"> -15 16 17 18 @@ -359,10 +360,11 @@ The document builder instance this objects xml will be added to. 27 28 29 -30</pre> +30 +31</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis_data.rb', line 15</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis_data.rb', line 16</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:cat'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> @@ -391,7 +393,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:34 2011 by + Generated on Wed Nov 23 21:44:32 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> diff --git a/doc/Axlsx/Cell.html b/doc/Axlsx/Cell.html index 97c47170..1519044e 100644 --- a/doc/Axlsx/Cell.html +++ b/doc/Axlsx/Cell.html @@ -1614,7 +1614,7 @@ xml text for the cell </div> <div id="footer"> - Generated on Wed Nov 23 12:36:30 2011 by + Generated on Wed Nov 23 21:44:46 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> diff --git a/doc/Axlsx/CellAlignment.html b/doc/Axlsx/CellAlignment.html index 5bdcf895..6e2a8155 100644 --- a/doc/Axlsx/CellAlignment.html +++ b/doc/Axlsx/CellAlignment.html @@ -1238,7 +1238,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:37 2011 by + Generated on Wed Nov 23 21:44:43 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> diff --git a/doc/Axlsx/CellProtection.html b/doc/Axlsx/CellProtection.html index 669e70ef..6937b970 100644 --- a/doc/Axlsx/CellProtection.html +++ b/doc/Axlsx/CellProtection.html @@ -556,7 +556,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:43 2011 by + Generated on Wed Nov 23 21:44:46 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> diff --git a/doc/Axlsx/CellStyle.html b/doc/Axlsx/CellStyle.html index 6f8eec14..a02f0170 100644 --- a/doc/Axlsx/CellStyle.html +++ b/doc/Axlsx/CellStyle.html @@ -940,7 +940,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:44 2011 by + Generated on Wed Nov 23 21:44:39 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> diff --git a/doc/Axlsx/Chart.html b/doc/Axlsx/Chart.html index 1260ec43..c5dc9212 100644 --- a/doc/Axlsx/Chart.html +++ b/doc/Axlsx/Chart.html @@ -1290,13 +1290,13 @@ Adds a new series to the chart’s series collection. <pre class="lines"> +100 101 102 -103 -104</pre> +103</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 101</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 100</span> <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> @@ -1385,13 +1385,13 @@ The row <pre class="lines"> +148 149 150 -151 -152</pre> +151</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 149</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 148</span> <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> @@ -1438,12 +1438,12 @@ markers <pre class="lines"> +93 94 -95 -96</pre> +95</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 94</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 93</span> <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> @@ -1532,13 +1532,13 @@ The row <pre class="lines"> +137 138 139 -140 -141</pre> +140</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 138</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 137</span> <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> @@ -1626,6 +1626,7 @@ Chart Serialization serializes the chart <pre class="lines"> +107 108 109 110 @@ -1647,11 +1648,10 @@ Chart Serialization serializes the chart 126 127 128 -129 -130</pre> +129</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 108</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 107</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> @@ -1687,7 +1687,7 @@ Chart Serialization serializes the chart </div> <div id="footer"> - Generated on Wed Nov 23 12:36:41 2011 by + Generated on Wed Nov 23 21:44:52 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> diff --git a/doc/Axlsx/Color.html b/doc/Axlsx/Color.html index 04ffc461..45f37f05 100644 --- a/doc/Axlsx/Color.html +++ b/doc/Axlsx/Color.html @@ -656,7 +656,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:34 2011 by + Generated on Wed Nov 23 21:44:38 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> diff --git a/doc/Axlsx/ContentType.html b/doc/Axlsx/ContentType.html index 5f853af7..0dc84a68 100644 --- a/doc/Axlsx/ContentType.html +++ b/doc/Axlsx/ContentType.html @@ -331,7 +331,7 @@ The document as a string. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:48 2011 by + Generated on Wed Nov 23 21:44:37 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> diff --git a/doc/Axlsx/Core.html b/doc/Axlsx/Core.html index 5ad9e059..494f3853 100644 --- a/doc/Axlsx/Core.html +++ b/doc/Axlsx/Core.html @@ -456,7 +456,7 @@ time when this method is called. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:40 2011 by + Generated on Wed Nov 23 21:44:40 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> diff --git a/doc/Axlsx/DataTypeValidator.html b/doc/Axlsx/DataTypeValidator.html index ed694a90..1847c874 100644 --- a/doc/Axlsx/DataTypeValidator.html +++ b/doc/Axlsx/DataTypeValidator.html @@ -315,7 +315,7 @@ types or the block passed returns false </div> <div id="footer"> - Generated on Wed Nov 23 12:36:27 2011 by + Generated on Wed Nov 23 21:44:37 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> diff --git a/doc/Axlsx/Default.html b/doc/Axlsx/Default.html index 3f689e96..e1f5c386 100644 --- a/doc/Axlsx/Default.html +++ b/doc/Axlsx/Default.html @@ -566,7 +566,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:31 2011 by + Generated on Wed Nov 23 21:44:39 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> diff --git a/doc/Axlsx/Drawing.html b/doc/Axlsx/Drawing.html index 26f3f3fa..8f899d2a 100644 --- a/doc/Axlsx/Drawing.html +++ b/doc/Axlsx/Drawing.html @@ -189,6 +189,34 @@ An array of charts that are associated with this drawing’s anchors. <li class="public "> <span class="summary_signature"> + <a href="#images-instance_method" title="#images (instance method)">- (Array) <strong>images</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <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> + + + <li class="public "> + <span class="summary_signature"> + <a href="#index-instance_method" title="#index (instance method)">- (Integer) <strong>index</strong> </a> @@ -389,6 +417,30 @@ Adds a chart to the drawing. <li class="public "> <span class="summary_signature"> + <a href="#add_image-instance_method" title="#add_image (instance method)">- (Object) <strong>add_image</strong>(options = {}) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Adds an image to the chart. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + <a href="#initialize-instance_method" title="#initialize (instance method)">- (Drawing) <strong>initialize</strong>(worksheet) </a> @@ -488,21 +540,21 @@ The worksheet that owns this drawing <pre class="lines"> -71 -72 -73 -74 -75 -76</pre> +80 +81 +82 +83 +84 +85</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 71</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 80</span> <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='TwoCellAnchor constant id'>TwoCellAnchor</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> @@ -557,12 +609,12 @@ in this version <pre class="lines"> -43 -44 -45</pre> +48 +49 +50</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 43</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 48</span> <span class='def def kw'>def</span> <span class='anchors identifier id'>anchors</span> <span class='@anchors ivar id'>@anchors</span> @@ -614,15 +666,77 @@ An array of charts that are associated with this drawing’s anchors <pre class="lines"> -47 -48 -49</pre> +52 +53 +54 +55</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 47</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 52</span> <span class='def def kw'>def</span> <span class='charts identifier id'>charts</span> - <span class='@anchors ivar id'>@anchors</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='graphic_frame identifier id'>graphic_frame</span><span class='dot token'>.</span><span class='chart identifier id'>chart</span> <span class='rbrace token'>}</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> +</div> + + + <span id=""></span> + <span id="images-instance_method"></span> + <div class="method_details "> + <p class="signature " id="images-instance_method"> + + - (<tt>Array</tt>) <strong>images</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +An array of image objects that are associated with this drawing’s +anchors +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Array</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +56 +57 +58 +59</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 56</span> + +<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> @@ -672,12 +786,12 @@ collection. <pre class="lines"> -51 -52 -53</pre> +60 +61 +62</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 51</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 60</span> <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> @@ -729,12 +843,12 @@ The part name for this drawing <pre class="lines"> -59 -60 -61</pre> +68 +69 +70</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 59</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 68</span> <span class='def def kw'>def</span> <span class='pn identifier id'>pn</span> <span class='dstring node'>"#{DRAWING_PN % (index+1)}"</span> @@ -786,24 +900,28 @@ The drawing’s relationships. <pre class="lines"> -67 -68 -69 -70 -71 -72 -73 -74</pre> +76 +77 +78 +79 +80 +81 +82 +83 +84 +85</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 67</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 76</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='@anchors ivar id'>@anchors</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='anchor identifier id'>anchor</span><span class='bitor op'>|</span> - <span class='chart identifier id'>chart</span> <span class='assign token'>=</span> <span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='graphic_frame identifier id'>graphic_frame</span><span class='dot token'>.</span><span class='chart identifier id'>chart</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> @@ -853,12 +971,12 @@ The relational part name for this drawing <pre class="lines"> -63 -64 -65</pre> +72 +73 +74</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 63</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 72</span> <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> @@ -910,12 +1028,12 @@ The relation reference id for this drawing <pre class="lines"> -55 -56 -57</pre> +64 +65 +66</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 55</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 64</span> <span class='def def kw'>def</span> <span class='rId identifier id'>rId</span> <span class='dstring node'>"rId#{index+1}"</span> @@ -967,12 +1085,12 @@ The worksheet that owns the drawing <pre class="lines"> -38 -39 -40</pre> +43 +44 +45</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 38</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 43</span> <span class='def def kw'>def</span> <span class='worksheet identifier id'>worksheet</span> <span class='@worksheet ivar id'>@worksheet</span> @@ -1032,17 +1150,77 @@ Adds a chart to the drawing. <pre class="lines"> -82 -83 -84 -85</pre> +98 +99 +100 +101</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 82</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 98</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='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='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='@anchors ivar id'>@anchors</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='graphic_frame identifier id'>graphic_frame</span><span class='dot token'>.</span><span class='chart identifier id'>chart</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> +</div> + + <div class="method_details "> + <p class="signature " id="add_image-instance_method"> + + - (<tt>Object</tt>) <strong>add_image</strong>(options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + + <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> + </div> + +<p> +Adds an image to the chart +</p> + + + </div> +</div> +<div class="tags"> + + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="Worksheet.html#add_image-instance_method" title="Axlsx::Worksheet#add_image (method)">Worksheet#add_image</a></span></li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +90 +91 +92 +93</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 90</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='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> @@ -1088,17 +1266,17 @@ Serializes the drawing <pre class="lines"> -118 -119 -120 -121 -122 -123 -124 -125</pre> +142 +143 +144 +145 +146 +147 +148 +149</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 118</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 142</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> @@ -1119,7 +1297,7 @@ Serializes the drawing </div> <div id="footer"> - Generated on Wed Nov 23 12:36:33 2011 by + Generated on Wed Nov 23 21:44:32 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> diff --git a/doc/Axlsx/Fill.html b/doc/Axlsx/Fill.html index 298476de..15e908a7 100644 --- a/doc/Axlsx/Fill.html +++ b/doc/Axlsx/Fill.html @@ -451,7 +451,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:40 2011 by + Generated on Wed Nov 23 21:44:43 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> diff --git a/doc/Axlsx/Font.html b/doc/Axlsx/Font.html index f5afba14..d67be582 100644 --- a/doc/Axlsx/Font.html +++ b/doc/Axlsx/Font.html @@ -1545,7 +1545,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:24 2011 by + Generated on Wed Nov 23 21:44:37 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> diff --git a/doc/Axlsx/GradientFill.html b/doc/Axlsx/GradientFill.html index 503858e2..162e7f63 100644 --- a/doc/Axlsx/GradientFill.html +++ b/doc/Axlsx/GradientFill.html @@ -1017,7 +1017,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:46 2011 by + Generated on Wed Nov 23 21:44:38 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> diff --git a/doc/Axlsx/GradientStop.html b/doc/Axlsx/GradientStop.html index 3e172370..455d8b1f 100644 --- a/doc/Axlsx/GradientStop.html +++ b/doc/Axlsx/GradientStop.html @@ -517,7 +517,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:29 2011 by + Generated on Wed Nov 23 21:44:49 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> diff --git a/doc/Axlsx/GraphicFrame.html b/doc/Axlsx/GraphicFrame.html index 6a3d3052..e9c4d8bc 100644 --- a/doc/Axlsx/GraphicFrame.html +++ b/doc/Axlsx/GraphicFrame.html @@ -326,14 +326,14 @@ Creates a new GraphicFrame object <pre class="lines"> +22 +23 24 25 -26 -27 -28</pre> +26</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 24</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 22</span> <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> @@ -392,12 +392,12 @@ A anchor that holds this frame <pre class="lines"> -15 -16 -17</pre> +13 +14 +15</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 15</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 13</span> <span class='def def kw'>def</span> <span class='anchor identifier id'>anchor</span> <span class='@anchor ivar id'>@anchor</span> @@ -449,12 +449,12 @@ A reference to the chart object associated with this frame <pre class="lines"> -11 -12 -13</pre> +9 +10 +11</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 11</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 9</span> <span class='def def kw'>def</span> <span class='chart identifier id'>chart</span> <span class='@chart ivar id'>@chart</span> @@ -506,12 +506,12 @@ The relationship id for this graphic <pre class="lines"> -19 -20 -21</pre> +17 +18 +19</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 19</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 17</span> <span class='def def kw'>def</span> <span class='rId identifier id'>rId</span> <span class='dstring node'>"rId#{@anchor.index+1}"</span> @@ -588,6 +588,8 @@ The document builder instance this objects xml will be added to. <pre class="lines"> +35 +36 37 38 39 @@ -603,12 +605,10 @@ The document builder instance this objects xml will be added to. 49 50 51 -52 -53 -54</pre> +52</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 37</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 35</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'>'xdr:graphicFrame'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> @@ -639,7 +639,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:30 2011 by + Generated on Wed Nov 23 21:44:37 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> diff --git a/doc/Axlsx/Line3DChart.html b/doc/Axlsx/Line3DChart.html index 3c39226b..8d4efe8d 100644 --- a/doc/Axlsx/Line3DChart.html +++ b/doc/Axlsx/Line3DChart.html @@ -993,7 +993,7 @@ Serializes the bar chart </div> <div id="footer"> - Generated on Wed Nov 23 12:36:45 2011 by + Generated on Wed Nov 23 21:44:44 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> diff --git a/doc/Axlsx/LineSeries.html b/doc/Axlsx/LineSeries.html index 4e0ca266..bfc616d6 100644 --- a/doc/Axlsx/LineSeries.html +++ b/doc/Axlsx/LineSeries.html @@ -251,8 +251,7 @@ Creates a new series. <span class="summary_desc"><div class='inline'><p> -Serializes the series TODO create series_cat and series_val classes as this -serialization is duplicated. +Serializes the series. </p> </div></span> @@ -514,8 +513,7 @@ The labels for this series. </p><div class="docstring"> <div class="discussion"> <p> -Serializes the series TODO create series_cat and series_val classes as this -serialization is duplicated +Serializes the series </p> @@ -564,15 +562,15 @@ The document builder instance this objects xml will be added to. <pre class="lines"> +29 30 31 32 33 -34 -35</pre> +34</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_series.rb', line 30</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_series.rb', line 29</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='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 identifier id'>xml</span><span class='bitor op'>|</span> @@ -591,7 +589,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:41 2011 by + Generated on Wed Nov 23 21:44:44 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> diff --git a/doc/Axlsx/Marker.html b/doc/Axlsx/Marker.html index aaa0ffd7..ff00dfd9 100644 --- a/doc/Axlsx/Marker.html +++ b/doc/Axlsx/Marker.html @@ -848,7 +848,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:42 2011 by + Generated on Wed Nov 23 21:44:49 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> diff --git a/doc/Axlsx/NumFmt.html b/doc/Axlsx/NumFmt.html index f82acc34..903ba32d 100644 --- a/doc/Axlsx/NumFmt.html +++ b/doc/Axlsx/NumFmt.html @@ -553,7 +553,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:33 2011 by + Generated on Wed Nov 23 21:44:31 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> diff --git a/doc/Axlsx/OneCellAnchor.html b/doc/Axlsx/OneCellAnchor.html new file mode 100644 index 00000000..bbc68665 --- /dev/null +++ b/doc/Axlsx/OneCellAnchor.html @@ -0,0 +1,988 @@ +<!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> + Class: Axlsx::OneCellAnchor + + — Documentation by YARD 0.7.3 + +</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 (O)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">OneCellAnchor</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>Class: Axlsx::OneCellAnchor + + + +</h1> + +<dl class="box"> + + <dt class="r1">Inherits:</dt> + <dd class="r1"> + <span class="inheritName">Object</span> + + <ul class="fullTree"> + <li>Object</li> + + <li class="next">Axlsx::OneCellAnchor</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/drawing/one_cell_anchor.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + + <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> + </div> + +<p> +This class details a single cell anchor for drawings. +</p> + + + </div> +</div> +<div class="tags"> + + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="Worksheet.html#add_chart-instance_method" title="Axlsx::Worksheet#add_chart (method)">Worksheet#add_chart</a></span></li> + + <li><span class='object_link'><a href="Worksheet.html#add_image-instance_method" title="Axlsx::Worksheet#add_image (method)">Worksheet#add_image</a></span></li> + + </ul> + +</div> + + <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2> + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> + + <a href="#drawing-instance_method" title="#drawing (instance method)">- (Drawing) <strong>drawing</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The drawing that holds this anchor. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#from-instance_method" title="#from (instance method)">- (Marker) <strong>from</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +A marker that defines the from cell anchor. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#height-instance_method" title="#height (instance method)">- (Integer) <strong>height</strong> </a> + + + + </span> + + + + + + + + + + + + <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> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#index-instance_method" title="#index (instance method)">- (Integer) <strong>index</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The index of this anchor in the drawing. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#object-instance_method" title="#object (instance method)">- (Pic) <strong>object</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The object this anchor hosts. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#width-instance_method" title="#width (instance method)">- (Integer) <strong>width</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +the width of the graphic object in pixels. +</p> +</div></span> + +</li> + + + </ul> + + + + + + <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="#initialize-instance_method" title="#initialize (instance method)">- (OneCellAnchor) <strong>initialize</strong>(drawing, options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new OneCellAnchor object and an Pic associated with it. +</p> +</div></span> + +</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 anchor. +</p> +</div></span> + +</li> + + + </ul> + + +<div id="constructor_details" class="method_details_list"> + <h2>Constructor Details</h2> + + <div class="method_details first"> + <p class="signature first" id="initialize-instance_method"> + + - (<tt><span class='object_link'><a href="" title="Axlsx::OneCellAnchor (class)">OneCellAnchor</a></span></tt>) <strong>initialize</strong>(drawing, options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new OneCellAnchor object and an Pic associated with it. +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>drawing</span> + + + <span class='type'>(<tt><span class='object_link'><a href="Drawing.html" title="Axlsx::Drawing (class)">Drawing</a></span></tt>)</span> + + + + </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">start_at</span> + <span class="type">(<tt>Array</tt>)</span> + <span class="default"> + + </span> + — <div class='inline'><p> +the col, row to start at +</p> +</div> + </li> + + <li> + <span class="name">width</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">height</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">image_src</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + — <div class='inline'><p> +the file location of the image you will render +</p> +</div> + </li> + + <li> + <span class="name">name</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + — <div class='inline'><p> +the name attribute for the rendered image +</p> +</div> + </li> + + <li> + <span class="name">descr</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + — <div class='inline'><p> +the description of the image rendered +</p> +</div> + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/one_cell_anchor.rb', line 44</span> + +<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> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id=""></span> + <span id="drawing-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="drawing-instance_method"> + + - (<tt><span class='object_link'><a href="Drawing.html" title="Axlsx::Drawing (class)">Drawing</a></span></tt>) <strong>drawing</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The drawing that holds this anchor +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Drawing.html" title="Axlsx::Drawing (class)">Drawing</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +18 +19 +20</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/one_cell_anchor.rb', line 18</span> + +<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> +</div> + + + <span id=""></span> + <span id="from-instance_method"></span> + <div class="method_details "> + <p class="signature " id="from-instance_method"> + + - (<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>) <strong>from</strong> <span class="extras">(readonly)</span> + + + +</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> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +10 +11 +12</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/one_cell_anchor.rb', line 10</span> + +<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> +</div> + + + <span id="height=-instance_method"></span> + <span id="height-instance_method"></span> + <div class="method_details "> + <p class="signature " id="height-instance_method"> + + - (<tt>Integer</tt>) <strong>height</strong> + + + +</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> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +33 +34 +35</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/one_cell_anchor.rb', line 33</span> + +<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> +</div> + + + <span id=""></span> + <span id="index-instance_method"></span> + <div class="method_details "> + <p class="signature " id="index-instance_method"> + + - (<tt>Integer</tt>) <strong>index</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The index of this anchor in the drawing +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +22 +23 +24</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/one_cell_anchor.rb', line 22</span> + +<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> +</div> + + + <span id=""></span> + <span id="object-instance_method"></span> + <div class="method_details "> + <p class="signature " id="object-instance_method"> + + - (<tt><span class='object_link'><a href="Pic.html" title="Axlsx::Pic (class)">Pic</a></span></tt>) <strong>object</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The object this anchor hosts +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Pic.html" title="Axlsx::Pic (class)">Pic</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +14 +15 +16</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/one_cell_anchor.rb', line 14</span> + +<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> +</div> + + + <span id="width=-instance_method"></span> + <span id="width-instance_method"></span> + <div class="method_details "> + <p class="signature " id="width-instance_method"> + + - (<tt>Integer</tt>) <strong>width</strong> + + + +</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> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +28 +29 +30</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/one_cell_anchor.rb', line 28</span> + +<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> +</div> + + </div> + + + <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_xml-instance_method"> + + - (<tt>String</tt>) <strong>to_xml</strong>(xml) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Serializes the anchor +</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"> + + +66 +67 +68 +69 +70 +71 +72 +73 +74 +75</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/one_cell_anchor.rb', line 66</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'>'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> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Wed Nov 23 21:44:33 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/Override.html b/doc/Axlsx/Override.html index 41bc5195..89360a19 100644 --- a/doc/Axlsx/Override.html +++ b/doc/Axlsx/Override.html @@ -559,7 +559,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:37 2011 by + Generated on Wed Nov 23 21:44:44 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> diff --git a/doc/Axlsx/Package.html b/doc/Axlsx/Package.html index ca431570..a28cf133 100644 --- a/doc/Axlsx/Package.html +++ b/doc/Axlsx/Package.html @@ -640,20 +640,20 @@ Creates the minimum content types for generating a valid xlsx document. <pre class="lines"> -156 -157 -158 -159 -160 -161 -162 -163 -164 -165 -166</pre> +182 +183 +184 +185 +186 +187 +188 +189 +190 +191 +192</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 156</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 182</span> <span class='def def kw'>def</span> <span class='base_content_types identifier id'>base_content_types</span> <span class='c_types identifier id'>c_types</span> <span class='assign token'>=</span> <span class='ContentType constant id'>ContentType</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='rparen token'>)</span> @@ -711,25 +711,36 @@ your workbook to the default content types. <pre class="lines"> -136 -137 -138 -139 -140 -141 -142 -143 -144 -145 -146 -147 -148 -149 -150 -151</pre> +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</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 136</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 151</span> <span class='def def kw'>def</span> <span class='content_types identifier id'>content_types</span> <span class='c_types identifier id'>c_types</span> <span class='assign token'>=</span> <span class='base_content_types identifier id'>base_content_types</span> @@ -745,6 +756,17 @@ your workbook to the default content types. <span class='c_types identifier id'>c_types</span> <span class='lshft op'><<</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Override constant id'>Override</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:PartName</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='dstring node'>"/xl/#{sheet.pn}"</span><span class='comma token'>,</span> <span class='symbol val'>:ContentType</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='WORKSHEET_CT constant id'>WORKSHEET_CT</span><span class='rparen token'>)</span> <span class='end end kw'>end</span> + <span class='exts identifier id'>exts</span> <span class='assign 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='map identifier id'>map</span> <span class='lbrace token'>{</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='extname identifier id'>extname</span> <span class='rbrace token'>}</span> + <span class='exts identifier id'>exts</span><span class='dot token'>.</span><span class='uniq identifier id'>uniq</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='ext identifier id'>ext</span><span class='bitor op'>|</span> + <span class='ct identifier id'>ct</span> <span class='assign token'>=</span> <span class='if if kw'>if</span> <span class='lbrack token'>[</span><span class='string val'>'jpeg'</span><span class='comma token'>,</span> <span class='string val'>'jpg'</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='ext identifier id'>ext</span><span class='rparen token'>)</span> + <span class='JPEG_CT constant id'>JPEG_CT</span> + <span class='elsif elsif kw'>elsif</span> <span class='ext identifier id'>ext</span> <span class='eq op'>==</span> <span class='string val'>'gif'</span> + <span class='GIF_CT constant id'>GIF_CT</span> + <span class='elsif elsif kw'>elsif</span> <span class='ext identifier id'>ext</span> <span class='eq op'>==</span> <span class='string val'>'png'</span> + <span class='PNG_CT constant id'>PNG_CT</span> + <span class='end end kw'>end</span> + <span class='c_types identifier id'>c_types</span> <span class='lshft op'><<</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Default constant id'>Default</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:ContentType</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ct identifier id'>ct</span><span class='comma token'>,</span> <span class='symbol val'>:Extension</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ext identifier id'>ext</span> <span class='rparen token'>)</span> + <span class='end end kw'>end</span> <span class='c_types identifier id'>c_types</span> <span class='end end kw'>end</span> </pre> @@ -798,17 +820,6 @@ of the package. <pre class="lines"> -90 -91 -92 -93 -94 -95 -96 -97 -98 -99 -100 101 102 103 @@ -822,10 +833,25 @@ of the package. 111 112 113 -114</pre> +114 +115 +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 90</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 101</span> <span class='def def kw'>def</span> <span class='parts identifier id'>parts</span> <span class='@parts ivar id'>@parts</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span> @@ -845,7 +871,11 @@ of the package. <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='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='@parts ivar id'>@parts</span> <span class='lshft op'><<</span> <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='dstring node'>"xl/#{chart.pn}"</span><span class='comma token'>,</span> <span class='symbol val'>:doc</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='comma token'>,</span> <span class='symbol val'>:schema</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='DRAWING_XSD constant id'>DRAWING_XSD</span><span class='rbrace token'>}</span> <span class='end end kw'>end</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='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='@parts ivar id'>@parts</span> <span class='lshft op'><<</span> <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='dstring node'>"xl/#{image.pn}"</span><span class='comma token'>,</span> <span class='symbol val'>:path</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='image identifier id'>image</span><span class='dot token'>.</span><span class='image_src identifier id'>image_src</span><span class='rbrace token'>}</span> + <span class='end end kw'>end</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='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='@parts ivar id'>@parts</span> <span class='lshft op'><<</span> <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='dstring node'>"xl/#{sheet.rels_pn}"</span><span class='comma token'>,</span> <span class='symbol val'>:doc</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='relationships identifier id'>relationships</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='comma token'>,</span> <span class='symbol val'>:schema</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='RELS_XSD constant id'>RELS_XSD</span><span class='rbrace token'>}</span> <span class='@parts ivar id'>@parts</span> <span class='lshft op'><<</span> <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='dstring node'>"xl/#{sheet.pn}"</span><span class='comma token'>,</span> <span class='symbol val'>:doc</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='to_xml identifier id'>to_xml</span><span class='comma token'>,</span> <span class='symbol val'>:schema</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='SML_XSD constant id'>SML_XSD</span><span class='rbrace token'>}</span> @@ -896,17 +926,17 @@ Creates the relationships required for a valid xlsx document <pre class="lines"> -171 -172 -173 -174 -175 -176 -177 -178</pre> +197 +198 +199 +200 +201 +202 +203 +204</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 171</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 197</span> <span class='def def kw'>def</span> <span class='relationships identifier id'>relationships</span> <span class='rels identifier id'>rels</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Relationships constant id'>Relationships</span><span class='dot token'>.</span><span class='new identifier id'>new</span> @@ -1046,17 +1076,39 @@ serialized 59 60 61 -62</pre> +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 55</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='f identifier id'>f</span> <span class='assign token'>=</span> <span class='File constant id'>File</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='output identifier id'>output</span><span class='comma token'>,</span> <span class='string val'>"w"</span><span class='rparen token'>)</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='f identifier id'>f</span><span class='dot token'>.</span><span class='path identifier id'>path</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='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='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='rbrace token'>}</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='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='unless unless_mod 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='end end kw'>end</span> + <span class='end end kw'>end</span> + <span class='Zip constant id'>Zip</span><span class='colon2 op'>::</span><span class='ZipFile constant id'>ZipFile</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='if if kw'>if</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='zip identifier id'>zip</span><span class='dot token'>.</span><span class='add identifier id'>add</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='comma 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='comma token'>,</span> <span class='bitand op'>&</span><span class='proc identifier id'>proc</span><span class='lbrace token'>{</span> <span class='true true kw'>true</span> <span class='rbrace 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> @@ -1147,18 +1199,18 @@ An array of all validation errors found. <pre class="lines"> -79 -80 -81 -82 -83</pre> +90 +91 +92 +93 +94</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 79</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 90</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='rbrace 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> @@ -1249,19 +1301,19 @@ An array of all validation errors encountered. <pre class="lines"> -122 -123 -124 -125 -126 -127 -128 -129 -130 -131</pre> +137 +138 +139 +140 +141 +142 +143 +144 +145 +146</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 122</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 137</span> <span class='def def kw'>def</span> <span class='validate_single_doc identifier id'>validate_single_doc</span><span class='lparen token'>(</span><span class='schema identifier id'>schema</span><span class='comma token'>,</span> <span class='doc identifier id'>doc</span><span class='rparen token'>)</span> <span class='schema identifier id'>schema</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='Schema constant id'>Schema</span><span class='lparen 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='schema identifier id'>schema</span><span class='rparen token'>)</span><span class='rparen token'>)</span> @@ -1284,7 +1336,7 @@ An array of all validation errors encountered. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:26 2011 by + Generated on Wed Nov 23 21:44:45 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> diff --git a/doc/Axlsx/PatternFill.html b/doc/Axlsx/PatternFill.html index be70ff59..0c671e70 100644 --- a/doc/Axlsx/PatternFill.html +++ b/doc/Axlsx/PatternFill.html @@ -672,7 +672,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:40 2011 by + Generated on Wed Nov 23 21:44:42 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> diff --git a/doc/Axlsx/Pic.html b/doc/Axlsx/Pic.html new file mode 100644 index 00000000..a204ec1b --- /dev/null +++ b/doc/Axlsx/Pic.html @@ -0,0 +1,1532 @@ +<!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> + Class: Axlsx::Pic + + — Documentation by YARD 0.7.3 + +</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 (P)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">Pic</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>Class: Axlsx::Pic + + + +</h1> + +<dl class="box"> + + <dt class="r1">Inherits:</dt> + <dd class="r1"> + <span class="inheritName">Object</span> + + <ul class="fullTree"> + <li>Object</li> + + <li class="next">Axlsx::Pic</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/drawing/pic.rb</dd> + +</dl> +<div class="clear"></div> + +<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> + + + </div> +</div> +<div class="tags"> + + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="Worksheet.html#add_image-instance_method" title="Axlsx::Worksheet#add_image (method)">Worksheet#add_image</a></span></li> + + </ul> + +</div> + <h2>Constant Summary</h2> + + <dl class="constants"> + + <dt id="ALLOWED_EXTENSIONS-constant" class="">ALLOWED_EXTENSIONS = + <div class="docstring"> + <div class="discussion"> + <p> +allowed file extenstions +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <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> + + + + <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2> + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> + + <a href="#anchor-instance_method" title="#anchor (instance method)">- (OneCellAnchor) <strong>anchor</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The anchor for this image. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#descr-instance_method" title="#descr (instance method)">- (String) <strong>descr</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +A description of the picture. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#extname-instance_method" title="#extname (instance method)">- (String) <strong>extname</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +returns the extension of image_src without the preceeding ’.’. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#file_name-instance_method" title="#file_name (instance method)">- (String) <strong>file_name</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The name of the image file, sans directory info. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#height-instance_method" title="#height (instance method)">- (Object) <strong>height</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +providing access to update the anchor’s height attribute. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#image_src-instance_method" title="#image_src (instance method)">- (String) <strong>image_src</strong> </a> + + + + </span> + + + + + + + + + + + + <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> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#index-instance_method" title="#index (instance method)">- (Index) <strong>index</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The index of this image in the workbooks images collections. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#name-instance_method" title="#name (instance method)">- (String) <strong>name</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The name to use for this picture. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#pn-instance_method" title="#pn (instance method)">- (String) <strong>pn</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The part name for this image used in serialization and relationship +building. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#width-instance_method" title="#width (instance method)">- (Object) <strong>width</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +providing access to the anchor’s width attribute. +</p> +</div></span> + +</li> + + + </ul> + + + + + + <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="#initialize-instance_method" title="#initialize (instance method)">- (Pic) <strong>initialize</strong>(anchor, options = {}) {|_self| ... }</a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new Pic(ture) object. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#start_at-instance_method" title="#start_at (instance method)">- (Marker) <strong>start_at</strong>(x, y) </a> + + + + </span> + + + + + + + + + <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> +</div></span> + +</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 picture. +</p> +</div></span> + +</li> + + + </ul> + + +<div id="constructor_details" class="method_details_list"> + <h2>Constructor Details</h2> + + <div class="method_details first"> + <p class="signature first" id="initialize-instance_method"> + + - (<tt><span class='object_link'><a href="" title="Axlsx::Pic (class)">Pic</a></span></tt>) <strong>initialize</strong>(anchor, options = {}) {|_self| ... } + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new Pic(ture) object +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>anchor</span> + + + <span class='type'>(<tt>Anchor</tt>)</span> + + + + — + <div class='inline'><p> +the anchor that holds this image +</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">name</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">descr</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">image_src</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">start_at</span> + <span class="type">(<tt>Array</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">width</span> + <span class="type">(<tt>Intger</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">height</span> + <span class="type">(<tt>Intger</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + +<h3>Yields:</h3> +<ul class="yield"> + + <li> + + + <span class='type'>(<tt>_self</tt>)</span> + + + + </li> + +</ul> +<h3>Yield Parameters:</h3> +<ul class="yieldparam"> + + <li> + + <span class='name'>_self</span> + + + <span class='type'>(<tt><span class='object_link'><a href="" title="Axlsx::Pic (class)">Axlsx::Pic</a></span></tt>)</span> + + + + — + <div class='inline'><p> +the object that the method was called on +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +66 +67 +68 +69 +70 +71 +72 +73 +74</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 66</span> + +<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='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='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> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id=""></span> + <span id="anchor-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="anchor-instance_method"> + + - (<tt><span class='object_link'><a href="OneCellAnchor.html" title="Axlsx::OneCellAnchor (class)">OneCellAnchor</a></span></tt>) <strong>anchor</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The anchor for this image +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="OneCellAnchor.html" title="Axlsx::OneCellAnchor (class)">OneCellAnchor</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +36 +37 +38</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 36</span> + +<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> +</div> + + + <span id="descr=-instance_method"></span> + <span id="descr-instance_method"></span> + <div class="method_details "> + <p class="signature " id="descr-instance_method"> + + - (<tt>String</tt>) <strong>descr</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +A description of the picture +</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"> + + +27 +28 +29</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 27</span> + +<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> +</div> + + + <span id=""></span> + <span id="extname-instance_method"></span> + <div class="method_details "> + <p class="signature " id="extname-instance_method"> + + - (<tt>String</tt>) <strong>extname</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +returns the extension of image_src without the preceeding ’.’ +</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"> + + +40 +41 +42</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 40</span> + +<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> +</div> + + + <span id=""></span> + <span id="file_name-instance_method"></span> + <div class="method_details "> + <p class="signature " id="file_name-instance_method"> + + - (<tt>String</tt>) <strong>file_name</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The name of the image file, sans directory info +</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"> + + +44 +45 +46</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 44</span> + +<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> +</div> + + + <span id="height=-instance_method"></span> + <span id="height-instance_method"></span> + <div class="method_details "> + <p class="signature " id="height-instance_method"> + + - (<tt>Object</tt>) <strong>height</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +providing access to update the anchor’s height attribute +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>v</span> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + </li> + +</ul> + + + <h3>See Also:</h3> + <ul class="see"> + + <li>OneCellAnchor.width</li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +23 +24 +25</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 23</span> + +<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> +</div> + + + <span id="image_src=-instance_method"></span> + <span id="image_src-instance_method"></span> + <div class="method_details "> + <p class="signature " id="image_src-instance_method"> + + - (<tt>String</tt>) <strong>image_src</strong> + + + +</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> + + + </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"> + + +32 +33 +34</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 32</span> + +<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> +</div> + + + <span id=""></span> + <span id="index-instance_method"></span> + <div class="method_details "> + <p class="signature " id="index-instance_method"> + + - (<tt>Index</tt>) <strong>index</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The index of this image in the workbooks images collections +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Index</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +52 +53 +54</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 52</span> + +<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> +</div> + + + <span id="name=-instance_method"></span> + <span id="name-instance_method"></span> + <div class="method_details "> + <p class="signature " id="name-instance_method"> + + - (<tt>String</tt>) <strong>name</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The name to use for this picture +</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"> + + +13 +14 +15</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 13</span> + +<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> +</div> + + + <span id=""></span> + <span id="pn-instance_method"></span> + <div class="method_details "> + <p class="signature " id="pn-instance_method"> + + - (<tt>String</tt>) <strong>pn</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The part name for this image used in serialization and relationship +building +</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"> + + +48 +49 +50</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 48</span> + +<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> +</div> + + + <span id="width=-instance_method"></span> + <span id="width-instance_method"></span> + <div class="method_details "> + <p class="signature " id="width-instance_method"> + + - (<tt>Object</tt>) <strong>width</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +providing access to the anchor’s width attribute +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>v</span> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + </li> + +</ul> + + + <h3>See Also:</h3> + <ul class="see"> + + <li>OneCellAnchor.width</li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +18 +19 +20</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 18</span> + +<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> +</div> + + </div> + + + <div id="instance_method_details" class="method_details_list"> + <h2>Instance Method Details</h2> + + + <div class="method_details first"> + <p class="signature first" id="start_at-instance_method"> + + - (<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>) <strong>start_at</strong>(x, y) + + + +</p><div class="docstring"> + <div class="discussion"> + <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> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>x</span> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +The column +</p> +</div> + + </li> + + <li> + + <span class='name'>y</span> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +The row +</p> +</div> + + </li> + +</ul> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +124 +125 +126 +127</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 124</span> + +<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> +</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 picture +</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"> + + +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154 +155 +156</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 132</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'>'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> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Wed Nov 23 21:44:51 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/Pie3DChart.html b/doc/Axlsx/Pie3DChart.html index 463ee085..81f128ff 100644 --- a/doc/Axlsx/Pie3DChart.html +++ b/doc/Axlsx/Pie3DChart.html @@ -388,8 +388,7 @@ a customizable set of options 25 26 27 -28 -29</pre> +28</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pie_3D_chart.rb', line 24</span> @@ -398,7 +397,6 @@ a customizable set of options <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> @@ -451,17 +449,17 @@ Serializes the pie chart <pre class="lines"> +32 33 34 35 36 37 38 -39 -40</pre> +39</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pie_3D_chart.rb', line 33</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pie_3D_chart.rb', line 32</span> <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> @@ -482,7 +480,7 @@ Serializes the pie chart </div> <div id="footer"> - Generated on Wed Nov 23 12:36:34 2011 by + Generated on Wed Nov 23 21:44:38 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> diff --git a/doc/Axlsx/PieSeries.html b/doc/Axlsx/PieSeries.html index ac8bc6bb..17d4e297 100644 --- a/doc/Axlsx/PieSeries.html +++ b/doc/Axlsx/PieSeries.html @@ -694,7 +694,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:27 2011 by + Generated on Wed Nov 23 21:44:43 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> diff --git a/doc/Axlsx/RegexValidator.html b/doc/Axlsx/RegexValidator.html index 5e0f6f0f..4dec6fee 100644 --- a/doc/Axlsx/RegexValidator.html +++ b/doc/Axlsx/RegexValidator.html @@ -259,7 +259,7 @@ The value to validate. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:30 2011 by + Generated on Wed Nov 23 21:44:39 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> diff --git a/doc/Axlsx/Relationship.html b/doc/Axlsx/Relationship.html index 8bea1e24..9480cc84 100644 --- a/doc/Axlsx/Relationship.html +++ b/doc/Axlsx/Relationship.html @@ -228,7 +228,7 @@ A new instance of Relationship. <span class="summary_desc"><div class='inline'><p> -Serializes the relationship TODO: use object.rId to get this infomation. +Serializes the relationship. </p> </div></span> @@ -454,7 +454,7 @@ The type of relationship </p><div class="docstring"> <div class="discussion"> <p> -Serializes the relationship TODO: use object.rId to get this infomation +Serializes the relationship </p> @@ -520,14 +520,14 @@ the reference id of the object. <pre class="lines"> +36 37 38 39 -40 -41</pre> +40</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/rels/relationship.rb', line 37</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/rels/relationship.rb', line 36</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='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> @@ -545,7 +545,7 @@ the reference id of the object. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:48 2011 by + Generated on Wed Nov 23 21:44:51 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> diff --git a/doc/Axlsx/Relationships.html b/doc/Axlsx/Relationships.html index a2d44c51..63f9f97f 100644 --- a/doc/Axlsx/Relationships.html +++ b/doc/Axlsx/Relationships.html @@ -334,7 +334,7 @@ Serializes the relationships document. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:31 2011 by + Generated on Wed Nov 23 21:44:43 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> diff --git a/doc/Axlsx/RestrictionValidator.html b/doc/Axlsx/RestrictionValidator.html index 5cea69a1..26518704 100644 --- a/doc/Axlsx/RestrictionValidator.html +++ b/doc/Axlsx/RestrictionValidator.html @@ -291,7 +291,7 @@ Raised if the value provided is not in the list of choices. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:34 2011 by + Generated on Wed Nov 23 21:44:40 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> diff --git a/doc/Axlsx/Row.html b/doc/Axlsx/Row.html index f4793412..97a255c2 100644 --- a/doc/Axlsx/Row.html +++ b/doc/Axlsx/Row.html @@ -762,7 +762,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:45 2011 by + Generated on Wed Nov 23 21:44:36 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> diff --git a/doc/Axlsx/Scaling.html b/doc/Axlsx/Scaling.html index 2d734018..fcf2813d 100644 --- a/doc/Axlsx/Scaling.html +++ b/doc/Axlsx/Scaling.html @@ -731,7 +731,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:31 2011 by + Generated on Wed Nov 23 21:44:39 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> diff --git a/doc/Axlsx/SerAxis.html b/doc/Axlsx/SerAxis.html index 54fdcdaf..1fd700a2 100644 --- a/doc/Axlsx/SerAxis.html +++ b/doc/Axlsx/SerAxis.html @@ -630,7 +630,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:41 2011 by + Generated on Wed Nov 23 21:44:51 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> diff --git a/doc/Axlsx/Series.html b/doc/Axlsx/Series.html index 22614377..6c966945 100644 --- a/doc/Axlsx/Series.html +++ b/doc/Axlsx/Series.html @@ -752,7 +752,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:42 2011 by + Generated on Wed Nov 23 21:44:36 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> diff --git a/doc/Axlsx/SeriesTitle.html b/doc/Axlsx/SeriesTitle.html index 0d48cf72..5819efb3 100644 --- a/doc/Axlsx/SeriesTitle.html +++ b/doc/Axlsx/SeriesTitle.html @@ -281,7 +281,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:46 2011 by + Generated on Wed Nov 23 21:44:40 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> diff --git a/doc/Axlsx/SimpleTypedList.html b/doc/Axlsx/SimpleTypedList.html index 268f2fc4..de9f323b 100644 --- a/doc/Axlsx/SimpleTypedList.html +++ b/doc/Axlsx/SimpleTypedList.html @@ -1677,7 +1677,7 @@ Unlock the list </div> <div id="footer"> - Generated on Wed Nov 23 12:36:36 2011 by + Generated on Wed Nov 23 21:44:47 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> diff --git a/doc/Axlsx/Styles.html b/doc/Axlsx/Styles.html index 3d111991..396f5ab0 100644 --- a/doc/Axlsx/Styles.html +++ b/doc/Axlsx/Styles.html @@ -1745,7 +1745,7 @@ Serializes the styles document </div> <div id="footer"> - Generated on Wed Nov 23 12:36:39 2011 by + Generated on Wed Nov 23 21:44:42 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> diff --git a/doc/Axlsx/TableStyle.html b/doc/Axlsx/TableStyle.html index 1d8f1584..76271084 100644 --- a/doc/Axlsx/TableStyle.html +++ b/doc/Axlsx/TableStyle.html @@ -701,7 +701,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:44 2011 by + Generated on Wed Nov 23 21:44:31 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> diff --git a/doc/Axlsx/TableStyleElement.html b/doc/Axlsx/TableStyleElement.html index 316cdc18..47a89fc4 100644 --- a/doc/Axlsx/TableStyleElement.html +++ b/doc/Axlsx/TableStyleElement.html @@ -668,7 +668,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:39 2011 by + Generated on Wed Nov 23 21:44:32 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> diff --git a/doc/Axlsx/TableStyles.html b/doc/Axlsx/TableStyles.html index bf84de69..2ef28eb3 100644 --- a/doc/Axlsx/TableStyles.html +++ b/doc/Axlsx/TableStyles.html @@ -590,7 +590,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:43 2011 by + Generated on Wed Nov 23 21:44:45 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> diff --git a/doc/Axlsx/Title.html b/doc/Axlsx/Title.html index b785b91f..2d0b20cb 100644 --- a/doc/Axlsx/Title.html +++ b/doc/Axlsx/Title.html @@ -616,7 +616,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:34 2011 by + Generated on Wed Nov 23 21:44:38 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> diff --git a/doc/Axlsx/TwoCellAnchor.html b/doc/Axlsx/TwoCellAnchor.html index 0e1ca139..f805ab7e 100644 --- a/doc/Axlsx/TwoCellAnchor.html +++ b/doc/Axlsx/TwoCellAnchor.html @@ -183,7 +183,7 @@ A marker that defines the from cell anchor. <li class="public "> <span class="summary_signature"> - <a href="#graphic_frame-instance_method" title="#graphic_frame (instance method)">- (GraphicFrame) <strong>graphic_frame</strong> </a> + <a href="#index-instance_method" title="#index (instance method)">- (Integer) <strong>index</strong> </a> @@ -200,7 +200,7 @@ A marker that defines the from cell anchor. <span class="summary_desc"><div class='inline'><p> -The frame for your chart. +The index of this anchor in the drawing. </p> </div></span> @@ -210,7 +210,7 @@ The frame for your chart. <li class="public "> <span class="summary_signature"> - <a href="#index-instance_method" title="#index (instance method)">- (Integer) <strong>index</strong> </a> + <a href="#object-instance_method" title="#object (instance method)">- (Pic, GraphicFrame) <strong>object</strong> </a> @@ -227,7 +227,7 @@ The frame for your chart. <span class="summary_desc"><div class='inline'><p> -The index of this anchor in the drawing. +The object this anchor hosts. </p> </div></span> @@ -277,7 +277,31 @@ A marker that returns the to cell anchor. <li class="public "> <span class="summary_signature"> - <a href="#initialize-instance_method" title="#initialize (instance method)">- (TwoCellAnchor) <strong>initialize</strong>(drawing, chart_type, options) </a> + <a href="#add_chart-instance_method" title="#add_chart (instance method)">- (Chart) <strong>add_chart</strong>(chart_type, options) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a graphic frame and chart object associated with this anchor. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#initialize-instance_method" title="#initialize (instance method)">- (TwoCellAnchor) <strong>initialize</strong>(drawing, options = {}) </a> @@ -334,13 +358,22 @@ Serializes the two cell anchor. <div class="method_details first"> <p class="signature first" id="initialize-instance_method"> - - (<tt><span class='object_link'><a href="" title="Axlsx::TwoCellAnchor (class)">TwoCellAnchor</a></span></tt>) <strong>initialize</strong>(drawing, chart_type, options) + - (<tt><span class='object_link'><a href="" title="Axlsx::TwoCellAnchor (class)">TwoCellAnchor</a></span></tt>) <strong>initialize</strong>(drawing, options = {}) </p><div class="docstring"> <div class="discussion"> - <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> + </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 @@ -384,12 +417,31 @@ subclass of Chart <li> + <span class='name'>object</span> + + + <span class='type'></span> + + + + — + <div class='inline'><p> +The object this anchor holds. +</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> @@ -406,8 +458,6 @@ a customizable set of options - - <h3>Options Hash (<tt>options</tt>):</h3> <ul class="option"> @@ -445,21 +495,19 @@ the col, row to end at <pre class="lines"> -34 -35 -36 -37 -38 -39</pre> +41 +42 +43 +44 +45</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 34</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 41</span> -<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='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='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='@graphic_frame ivar id'>@graphic_frame</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='end end kw'>end</span> </pre> </td> @@ -513,12 +561,12 @@ The drawing that holds this anchor <pre class="lines"> -20 -21 -22</pre> +25 +26 +27</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 20</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 25</span> <span class='def def kw'>def</span> <span class='drawing identifier id'>drawing</span> <span class='@drawing ivar id'>@drawing</span> @@ -589,18 +637,18 @@ are 0 and 0 respectively <span id=""></span> - <span id="graphic_frame-instance_method"></span> + <span id="index-instance_method"></span> <div class="method_details "> - <p class="signature " id="graphic_frame-instance_method"> + <p class="signature " id="index-instance_method"> - - (<tt><span class='object_link'><a href="GraphicFrame.html" title="Axlsx::GraphicFrame (class)">GraphicFrame</a></span></tt>) <strong>graphic_frame</strong> <span class="extras">(readonly)</span> + - (<tt>Integer</tt>) <strong>index</strong> <span class="extras">(readonly)</span> </p><div class="docstring"> <div class="discussion"> <p> -The frame for your chart +The index of this anchor in the drawing </p> @@ -614,7 +662,7 @@ The frame for your chart <li> - <span class='type'>(<tt><span class='object_link'><a href="GraphicFrame.html" title="Axlsx::GraphicFrame (class)">GraphicFrame</a></span></tt>)</span> + <span class='type'>(<tt>Integer</tt>)</span> @@ -628,15 +676,15 @@ The frame for your chart <pre class="lines"> -16 -17 -18</pre> +29 +30 +31</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 16</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 29</span> -<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='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> @@ -646,18 +694,18 @@ The frame for your chart <span id=""></span> - <span id="index-instance_method"></span> + <span id="object-instance_method"></span> <div class="method_details "> - <p class="signature " id="index-instance_method"> + <p class="signature " id="object-instance_method"> - - (<tt>Integer</tt>) <strong>index</strong> <span class="extras">(readonly)</span> + - (<tt><span class='object_link'><a href="Pic.html" title="Axlsx::Pic (class)">Pic</a></span></tt>, <tt><span class='object_link'><a href="GraphicFrame.html" title="Axlsx::GraphicFrame (class)">GraphicFrame</a></span></tt>) <strong>object</strong> <span class="extras">(readonly)</span> </p><div class="docstring"> <div class="discussion"> <p> -The index of this anchor in the drawing +The object this anchor hosts </p> @@ -671,7 +719,7 @@ The index of this anchor in the drawing <li> - <span class='type'>(<tt>Integer</tt>)</span> + <span class='type'>(<tt><span class='object_link'><a href="Pic.html" title="Axlsx::Pic (class)">Pic</a></span></tt>, <tt><span class='object_link'><a href="GraphicFrame.html" title="Axlsx::GraphicFrame (class)">GraphicFrame</a></span></tt>)</span> @@ -685,15 +733,15 @@ The index of this anchor in the drawing <pre class="lines"> -24 -25 -26</pre> +21 +22 +23</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 24</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 21</span> -<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='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> @@ -767,7 +815,63 @@ A marker that returns the to cell anchor. The default to column and row are <div class="method_details first"> - <p class="signature first" id="to_xml-instance_method"> + <p class="signature first" id="add_chart-instance_method"> + + - (<tt><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></tt>) <strong>add_chart</strong>(chart_type, options) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a graphic frame and chart object associated with this anchor +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +49 +50 +51 +52</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 49</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='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> +</div> + + <div class="method_details "> + <p class="signature " id="to_xml-instance_method"> - (<tt>String</tt>) <strong>to_xml</strong>(xml) @@ -825,22 +929,22 @@ The document builder instance this objects xml will be added to. <pre class="lines"> -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59</pre> +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 47</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.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='comment val'>#build it for now, break it down later!</span> @@ -851,7 +955,7 @@ The document builder instance this objects xml will be added to. <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='@graphic_frame ivar id'>@graphic_frame</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='@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> @@ -866,7 +970,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:44 2011 by + Generated on Wed Nov 23 21:44:37 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> diff --git a/doc/Axlsx/ValAxis.html b/doc/Axlsx/ValAxis.html index 54a0fd41..37412dd8 100644 --- a/doc/Axlsx/ValAxis.html +++ b/doc/Axlsx/ValAxis.html @@ -529,7 +529,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:42 2011 by + Generated on Wed Nov 23 21:44:31 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> diff --git a/doc/Axlsx/ValAxisData.html b/doc/Axlsx/ValAxisData.html index 7fb222d2..a471d919 100644 --- a/doc/Axlsx/ValAxisData.html +++ b/doc/Axlsx/ValAxisData.html @@ -317,7 +317,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:25 2011 by + Generated on Wed Nov 23 21:44:47 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> diff --git a/doc/Axlsx/View3D.html b/doc/Axlsx/View3D.html index c310792f..3239e75b 100644 --- a/doc/Axlsx/View3D.html +++ b/doc/Axlsx/View3D.html @@ -962,7 +962,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:35 2011 by + Generated on Wed Nov 23 21:44:40 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> diff --git a/doc/Axlsx/Workbook.html b/doc/Axlsx/Workbook.html index 47675817..bd6b1e44 100644 --- a/doc/Axlsx/Workbook.html +++ b/doc/Axlsx/Workbook.html @@ -243,6 +243,33 @@ A colllection of drawings associated with this workbook. <li class="public "> <span class="summary_signature"> + <a href="#images-instance_method" title="#images (instance method)">- (SimpleTypedList) <strong>images</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +A colllection of images associated with this workbook. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + <a href="#relationships-instance_method" title="#relationships (instance method)">- (Relationships) <strong>relationships</strong> </a> @@ -571,23 +598,25 @@ the object that the method was called on <pre class="lines"> -75 -76 -77 -78 -79 -80 -81 -82</pre> +82 +83 +84 +85 +86 +87 +88 +89 +90</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 75</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 82</span> <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> @@ -718,10 +747,10 @@ Instance level access to the class variable 1904 <pre class="lines"> -67</pre> +74</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 67</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 74</span> <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> @@ -789,6 +818,81 @@ A colllection of drawings associated with this workbook <pre class="lines"> +59 +60 +61</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 59</span> + +<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> +</div> + + + <span id=""></span> + <span id="images-instance_method"></span> + <div class="method_details "> + <p class="signature " id="images-instance_method"> + + - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>images</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <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> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span> + + + + </li> + +</ul> + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="Worksheet.html#add_image-instance_method" title="Axlsx::Worksheet#add_image (method)">Axlsx::Worksheet#add_image</a></span></li> + + <li><span class='object_link'><a href="Pic.html" title="Axlsx::Pic (class)">Pic</a></span></li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + 52 53 54</pre> @@ -796,8 +900,8 @@ A colllection of drawings associated with this workbook <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 52</span> -<span class='def def kw'>def</span> <span class='drawings identifier id'>drawings</span> - <span class='@drawings ivar id'>@drawings</span> +<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> @@ -846,17 +950,17 @@ The workbook relationships. This is managed automatically by the workbook <pre class="lines"> -63 -64 -65 -66 -67 -68 -69 -70</pre> +70 +71 +72 +73 +74 +75 +76 +77</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 63</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 70</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> @@ -931,12 +1035,12 @@ The styles associated with this workbook <pre class="lines"> -59 -60 -61</pre> +66 +67 +68</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 59</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 66</span> <span class='def def kw'>def</span> <span class='styles identifier id'>styles</span> <span class='@styles ivar id'>@styles</span> @@ -1067,10 +1171,10 @@ retrieves the date1904 attribute <pre class="lines"> -93</pre> +101</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 93</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 101</span> <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> @@ -1117,10 +1221,10 @@ Sets the date1904 attribute to the provided boolean <pre class="lines"> -89</pre> +97</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 89</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 97</span> <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> @@ -1237,14 +1341,14 @@ The name of the worksheet. <pre class="lines"> -99 -100 -101 -102 -103</pre> +107 +108 +109 +110 +111</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 99</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 107</span> <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> @@ -1295,23 +1399,23 @@ Serializes the workbook document <pre class="lines"> -116 -117 -118 -119 -120 -121 -122 -123 124 125 126 127 128 -129</pre> +129 +130 +131 +132 +133 +134 +135 +136 +137</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 116</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 124</span> <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> @@ -1338,7 +1442,7 @@ Serializes the workbook document </div> <div id="footer"> - Generated on Wed Nov 23 12:36:36 2011 by + Generated on Wed Nov 23 21:44:48 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> diff --git a/doc/Axlsx/Worksheet.html b/doc/Axlsx/Worksheet.html index 3b43a42c..74a98d58 100644 --- a/doc/Axlsx/Worksheet.html +++ b/doc/Axlsx/Worksheet.html @@ -419,6 +419,30 @@ Adds a chart to this worksheets drawing. <li class="public "> <span class="summary_signature"> + <a href="#add_image-instance_method" title="#add_image (instance method)">- (Object) <strong>add_image</strong>(options = {}) {|image| ... }</a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Adds a media item to the worksheets drawing. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + <a href="#add_row-instance_method" title="#add_row (instance method)">- (Row) <strong>add_row</strong>(values = [], options = {}) {|@rows.last| ... }</a> @@ -1454,6 +1478,119 @@ a customizable set of options </div> <div class="method_details "> + <p class="signature " id="add_image-instance_method"> + + - (<tt>Object</tt>) <strong>add_image</strong>(options = {}) {|image| ... } + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Adds a media item to the worksheets drawing +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>media_type</span> + + + <span class='type'>(<tt>Class</tt>)</span> + + + + </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">[]</span> + <span class="type">(<tt>Object</tt>)</span> + <span class="default"> + + </span> + — <div class='inline'><p> +unknown +</p> +</div> + </li> + + </ul> + + +<h3>Yields:</h3> +<ul class="yield"> + + <li> + + + <span class='type'>(<tt>image</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +125 +126 +127 +128 +129</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 125</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> +</div> + + <div class="method_details "> <p class="signature " id="add_row-instance_method"> - (<tt><span class='object_link'><a href="Row.html" title="Axlsx::Row (class)">Row</a></span></tt>) <strong>add_row</strong>(values = [], options = {}) {|@rows.last| ... } @@ -1660,22 +1797,22 @@ hash of auto_fit_data <pre class="lines"> -190 -191 -192 -193 -194 -195 -196 -197 -198 -199</pre> +199 +200 +201 +202 +203 +204 +205 +206 +207 +208</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 190</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 199</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 in testable fonts so instead of beating RMagick every time, I am hardcoding it here.</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> @@ -1728,15 +1865,6 @@ Serializes the worksheet document <pre class="lines"> -124 -125 -126 -127 -128 -129 -130 -131 -132 133 134 135 @@ -1748,10 +1876,19 @@ Serializes the worksheet document 141 142 143 -144</pre> +144 +145 +146 +147 +148 +149 +150 +151 +152 +153</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 124</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 133</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> @@ -1847,15 +1984,6 @@ of Cell objects <pre class="lines"> -162 -163 -164 -165 -166 -167 -168 -169 -170 171 172 173 @@ -1865,10 +1993,19 @@ of Cell objects 177 178 179 -180</pre> +180 +181 +182 +183 +184 +185 +186 +187 +188 +189</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 162</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 171</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> @@ -1900,7 +2037,7 @@ of Cell objects </div> <div id="footer"> - Generated on Wed Nov 23 12:36:32 2011 by + Generated on Wed Nov 23 21:44:35 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> diff --git a/doc/Axlsx/Xf.html b/doc/Axlsx/Xf.html index 3bc5617c..ce88b303 100644 --- a/doc/Axlsx/Xf.html +++ b/doc/Axlsx/Xf.html @@ -1672,7 +1672,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 12:36:25 2011 by + Generated on Wed Nov 23 21:44:48 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> diff --git a/doc/_index.html b/doc/_index.html index aecdfb4b..c1c95126 100644 --- a/doc/_index.html +++ b/doc/_index.html @@ -357,6 +357,13 @@ <ul> <li> + <span class='object_link'><a href="Axlsx/OneCellAnchor.html" title="Axlsx::OneCellAnchor (class)">OneCellAnchor</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> <span class='object_link'><a href="Axlsx/Override.html" title="Axlsx::Override (class)">Override</a></span> <small>(Axlsx)</small> @@ -386,6 +393,13 @@ </li> <li> + <span class='object_link'><a href="Axlsx/Pic.html" title="Axlsx::Pic (class)">Pic</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> <span class='object_link'><a href="Axlsx/Pie3DChart.html" title="Axlsx::Pie3DChart (class)">Pie3DChart</a></span> <small>(Axlsx)</small> @@ -616,7 +630,7 @@ </div> <div id="footer"> - Generated on Wed Nov 23 12:36:23 2011 by + Generated on Wed Nov 23 21:44:30 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> diff --git a/doc/class_list.html b/doc/class_list.html index 768281a5..060e3f46 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/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/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/SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span> < Object<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><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/SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span> < Object<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.README.html b/doc/file.README.html index 028a3e27..547e4874 100644 --- a/doc/file.README.html +++ b/doc/file.README.html @@ -61,14 +61,14 @@ <strong>Author</strong>: Randy Morgan <br/> <strong>Copyright</strong>: 2011 <br/> <strong>License</strong>: MIT License <br/> -<strong>Latest Version</strong>: 1.0.7 <br/> +<strong>Latest Version</strong>: 1.0.8 <br/> <strong>Ruby Version</strong>: 1.8.7 <br/> <strong>Release Date</strong>: November 23nd 2011</p> <h2>Synopsis</h2> <p>Axlsx is an Office Open XML Spreadsheet generator for the Ruby programming language. -It enables the you to generate 100% valid xlsx files that include customised styling 3D pie, bar and line charts. Below is a summary of salient features.</p> +It enables the you to generate 100% valid xlsx files that include customised styling, images, 3D pie, bar and line charts and auto-width columns. Below is a summary of salient features.</p> <h2>Feature List</h2> @@ -84,6 +84,8 @@ It enables the you to generate 100% valid xlsx files that include customised sty <p>**6. Support for both 1904 and 1900 epocs configurable in the workbook.</p> +<p>**7. Add jpg, gif and png images to worksheets</p> + <h2>Installing</h2> <p>To install Axlsx, use the following command:</p> @@ -193,6 +195,19 @@ It enables the you to generate 100% valid xlsx files that include customised sty <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='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> + <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> @@ -208,7 +223,13 @@ It enables the you to generate 100% valid xlsx files that include customised sty <h2>Changelog</h2> <ul> -<li><strong>October.23.11</strong>: 1.0.7 released +<li><p><strong>October.23.11</strong>: 1.0.8 release</p> + +<ul> +<li>Added support for images (jpg, gif, png) in worksheets.</li> +</ul> +</li> +<li><p><strong>October.23.11</strong>: 1.0.7 released</p> <ul> <li>Added support for 3D options when creating a new chart. This lets you set the persective, rotation and other 3D attributes when using worksheet.add_chart</li> @@ -227,6 +248,10 @@ It enables the you to generate 100% valid xlsx files that include customised sty <p>Please see the <a href="file.CHANGELOG.html" title="CHANGELOG">CHANGELOG</a> document for past release information.</p> +<h2>Help Wanted</h2> + +<p>I'd really like to get rid of the depenency on RMagick in this gem. RMagic is being used to calculate the column widths in a worksheet based on the content the user specified. If there happens to be anyone out there with the background and skill set to write an extenstion that can determine the width of a singel character render with a specific font at a specific size please give me a shout.</p> + <h2>Copyright</h2> <p>Axlsx © 2011 by <a href="mailto:[email protected]">Randy Morgan</a>. Axlsx is @@ -234,7 +259,7 @@ licensed under the MIT license. Please see the <a href="file.LICENSE.html" title </div></div> <div id="footer"> - Generated on Wed Nov 23 12:36:23 2011 by + Generated on Wed Nov 23 21:44:31 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> diff --git a/doc/index.html b/doc/index.html index 028a3e27..7f999f96 100644 --- a/doc/index.html +++ b/doc/index.html @@ -61,14 +61,14 @@ <strong>Author</strong>: Randy Morgan <br/> <strong>Copyright</strong>: 2011 <br/> <strong>License</strong>: MIT License <br/> -<strong>Latest Version</strong>: 1.0.7 <br/> +<strong>Latest Version</strong>: 1.0.8 <br/> <strong>Ruby Version</strong>: 1.8.7 <br/> <strong>Release Date</strong>: November 23nd 2011</p> <h2>Synopsis</h2> <p>Axlsx is an Office Open XML Spreadsheet generator for the Ruby programming language. -It enables the you to generate 100% valid xlsx files that include customised styling 3D pie, bar and line charts. Below is a summary of salient features.</p> +It enables the you to generate 100% valid xlsx files that include customised styling, images, 3D pie, bar and line charts and auto-width columns. Below is a summary of salient features.</p> <h2>Feature List</h2> @@ -84,6 +84,8 @@ It enables the you to generate 100% valid xlsx files that include customised sty <p>**6. Support for both 1904 and 1900 epocs configurable in the workbook.</p> +<p>**7. Add jpg, gif and png images to worksheets</p> + <h2>Installing</h2> <p>To install Axlsx, use the following command:</p> @@ -193,6 +195,19 @@ It enables the you to generate 100% valid xlsx files that include customised sty <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='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> + <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> @@ -208,7 +223,13 @@ It enables the you to generate 100% valid xlsx files that include customised sty <h2>Changelog</h2> <ul> -<li><strong>October.23.11</strong>: 1.0.7 released +<li><p><strong>October.23.11</strong>: 1.0.8 release</p> + +<ul> +<li>Added support for images (jpg, gif, png) in worksheets.</li> +</ul> +</li> +<li><p><strong>October.23.11</strong>: 1.0.7 released</p> <ul> <li>Added support for 3D options when creating a new chart. This lets you set the persective, rotation and other 3D attributes when using worksheet.add_chart</li> @@ -227,6 +248,10 @@ It enables the you to generate 100% valid xlsx files that include customised sty <p>Please see the <a href="file.CHANGELOG.html" title="CHANGELOG">CHANGELOG</a> document for past release information.</p> +<h2>Help Wanted</h2> + +<p>I'd really like to get rid of the depenency on RMagick in this gem. RMagic is being used to calculate the column widths in a worksheet based on the content the user specified. If there happens to be anyone out there with the background and skill set to write an extenstion that can determine the width of a singel character render with a specific font at a specific size please give me a shout.</p> + <h2>Copyright</h2> <p>Axlsx © 2011 by <a href="mailto:[email protected]">Randy Morgan</a>. Axlsx is @@ -234,7 +259,7 @@ licensed under the MIT license. Please see the <a href="file.LICENSE.html" title </div></div> <div id="footer"> - Generated on Wed Nov 23 12:36:23 2011 by + Generated on Wed Nov 23 21:44:30 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> diff --git a/doc/method_list.html b/doc/method_list.html index 8b35aedf..704dd4d6 100644 --- a/doc/method_list.html +++ b/doc/method_list.html @@ -321,7 +321,23 @@ <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/TwoCellAnchor.html#add_chart-instance_method" title="Axlsx::TwoCellAnchor#add_chart (method)">#add_chart</a></span> + + <small>Axlsx::TwoCellAnchor</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Drawing.html#add_image-instance_method" title="Axlsx::Drawing#add_image (method)">#add_image</a></span> + + <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> <small>Axlsx::Worksheet</small> @@ -329,6 +345,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 +360,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 +368,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 +376,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,7 +384,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/SimpleTypedList.html#allowed_types-instance_method" title="Axlsx::SimpleTypedList#allowed_types (method)">#allowed_types</a></span> <small>Axlsx::SimpleTypedList</small> @@ -368,7 +392,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/GraphicFrame.html#anchor-instance_method" title="Axlsx::GraphicFrame#anchor (method)">#anchor</a></span> <small>Axlsx::GraphicFrame</small> @@ -376,6 +400,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/Drawing.html#anchors-instance_method" title="Axlsx::Drawing#anchors (method)">#anchors</a></span> @@ -633,33 +665,33 @@ <li class="r1 "> - <span class='object_link'><a href="Axlsx/Series.html#chart-instance_method" title="Axlsx::Series#chart (method)">#chart</a></span> + <span class='object_link'><a href="Axlsx/GraphicFrame.html#chart-instance_method" title="Axlsx::GraphicFrame#chart (method)">#chart</a></span> - <small>Axlsx::Series</small> + <small>Axlsx::GraphicFrame</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/GraphicFrame.html#chart-instance_method" title="Axlsx::GraphicFrame#chart (method)">#chart</a></span> + <span class='object_link'><a href="Axlsx/Series.html#chart-instance_method" title="Axlsx::Series#chart (method)">#chart</a></span> - <small>Axlsx::GraphicFrame</small> + <small>Axlsx::Series</small> </li> <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> @@ -689,25 +721,25 @@ <li class="r2 "> - <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/Font.html#color-instance_method" title="Axlsx::Font#color (method)">#color</a></span> - <small>Axlsx::GradientStop</small> + <small>Axlsx::Font</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> + <span class='object_link'><a href="Axlsx/BorderPr.html#color-instance_method" title="Axlsx::BorderPr#color (method)">#color</a></span> - <small>Axlsx::Font</small> + <small>Axlsx::BorderPr</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/BorderPr.html#color-instance_method" title="Axlsx::BorderPr#color (method)">#color</a></span> + <span class='object_link'><a href="Axlsx/GradientStop.html#color-instance_method" title="Axlsx::GradientStop#color (method)">#color</a></span> - <small>Axlsx::BorderPr</small> + <small>Axlsx::GradientStop</small> </li> @@ -777,31 +809,31 @@ <li class="r1 "> - <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/BarSeries.html#data-instance_method" title="Axlsx::BarSeries#data (method)">#data</a></span> - <small>Axlsx::PieSeries</small> + <small>Axlsx::BarSeries</small> </li> <li class="r2 "> - <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/LineSeries.html#data-instance_method" title="Axlsx::LineSeries#data (method)">#data</a></span> - <small>Axlsx::BarSeries</small> + <small>Axlsx::LineSeries</small> </li> <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/PieSeries.html#data-instance_method" title="Axlsx::PieSeries#data (method)">#data</a></span> - <small>Axlsx::LineSeries</small> + <small>Axlsx::PieSeries</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Workbook.html#date1904-class_method" title="Axlsx::Workbook.date1904 (method)">date1904</a></span> + <span class='object_link'><a href="Axlsx/Workbook.html#date1904-instance_method" title="Axlsx::Workbook#date1904 (method)">#date1904</a></span> <small>Axlsx::Workbook</small> @@ -809,7 +841,7 @@ <li class="r1 "> - <span class='object_link'><a href="Axlsx/Workbook.html#date1904-instance_method" title="Axlsx::Workbook#date1904 (method)">#date1904</a></span> + <span class='object_link'><a href="Axlsx/Workbook.html#date1904-class_method" title="Axlsx::Workbook.date1904 (method)">date1904</a></span> <small>Axlsx::Workbook</small> @@ -873,6 +905,14 @@ <li class="r1 "> + <span class='object_link'><a href="Axlsx/Pic.html#descr-instance_method" title="Axlsx::Pic#descr (method)">#descr</a></span> + + <small>Axlsx::Pic</small> + + </li> + + + <li class="r2 "> <span class='object_link'><a href="Axlsx/Border.html#diagonalDown-instance_method" title="Axlsx::Border#diagonalDown (method)">#diagonalDown</a></span> <small>Axlsx::Border</small> @@ -880,7 +920,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/Border.html#diagonalUp-instance_method" title="Axlsx::Border#diagonalUp (method)">#diagonalUp</a></span> <small>Axlsx::Border</small> @@ -888,6 +928,14 @@ </li> + <li class="r2 "> + <span class='object_link'><a href="Axlsx/TwoCellAnchor.html#drawing-instance_method" title="Axlsx::TwoCellAnchor#drawing (method)">#drawing</a></span> + + <small>Axlsx::TwoCellAnchor</small> + + </li> + + <li class="r1 "> <span class='object_link'><a href="Axlsx/Worksheet.html#drawing-instance_method" title="Axlsx::Worksheet#drawing (method)">#drawing</a></span> @@ -897,9 +945,9 @@ <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> @@ -953,6 +1001,14 @@ <li class="r1 "> + <span class='object_link'><a href="Axlsx/Pic.html#extname-instance_method" title="Axlsx::Pic#extname (method)">#extname</a></span> + + <small>Axlsx::Pic</small> + + </li> + + + <li class="r2 "> <span class='object_link'><a href="Axlsx/Font.html#family-instance_method" title="Axlsx::Font#family (method)">#family</a></span> <small>Axlsx::Font</small> @@ -960,7 +1016,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/PatternFill.html#fgColor-instance_method" title="Axlsx::PatternFill#fgColor (method)">#fgColor</a></span> <small>Axlsx::PatternFill</small> @@ -968,6 +1024,14 @@ </li> + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Pic.html#file_name-instance_method" title="Axlsx::Pic#file_name (method)">#file_name</a></span> + + <small>Axlsx::Pic</small> + + </li> + + <li class="r1 "> <span class='object_link'><a href="Axlsx/Xf.html#fillId-instance_method" title="Axlsx::Xf#fillId (method)">#fillId</a></span> @@ -1025,39 +1089,39 @@ <li class="r2 "> - <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/TwoCellAnchor.html#from-instance_method" title="Axlsx::TwoCellAnchor#from (method)">#from</a></span> - <small>Axlsx::Chart</small> + <small>Axlsx::TwoCellAnchor</small> </li> <li class="r1 "> - <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="r2 "> - <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/OneCellAnchor.html#from-instance_method" title="Axlsx::OneCellAnchor#from (method)">#from</a></span> - <small>Axlsx::Line3DChart</small> + <small>Axlsx::OneCellAnchor</small> </li> <li class="r1 "> - <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="r2 "> - <span class='object_link'><a href="Axlsx/Bar3DChart.html#gapWidth-instance_method" title="Axlsx::Bar3DChart#gapWidth (method)">#gapWidth</a></span> + <span class='object_link'><a href="Axlsx/Bar3DChart.html#gapDepth-instance_method" title="Axlsx::Bar3DChart#gapDepth (method)">#gapDepth</a></span> <small>Axlsx::Bar3DChart</small> @@ -1065,17 +1129,17 @@ <li class="r1 "> - <span class='object_link'><a href="Axlsx/Chart.html#graphic_frame-instance_method" title="Axlsx::Chart#graphic_frame (method)">#graphic_frame</a></span> + <span class='object_link'><a href="Axlsx/Bar3DChart.html#gapWidth-instance_method" title="Axlsx::Bar3DChart#gapWidth (method)">#gapWidth</a></span> - <small>Axlsx::Chart</small> + <small>Axlsx::Bar3DChart</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/TwoCellAnchor.html#graphic_frame-instance_method" title="Axlsx::TwoCellAnchor#graphic_frame (method)">#graphic_frame</a></span> + <span class='object_link'><a href="Axlsx/Chart.html#graphic_frame-instance_method" title="Axlsx::Chart#graphic_frame (method)">#graphic_frame</a></span> - <small>Axlsx::TwoCellAnchor</small> + <small>Axlsx::Chart</small> </li> @@ -1105,14 +1169,22 @@ <li class="r2 "> - <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/OneCellAnchor.html#height-instance_method" title="Axlsx::OneCellAnchor#height (method)">#height</a></span> - <small>Axlsx::CellProtection</small> + <small>Axlsx::OneCellAnchor</small> </li> <li class="r1 "> + <span class='object_link'><a href="Axlsx/Pic.html#height-instance_method" title="Axlsx::Pic#height (method)">#height</a></span> + + <small>Axlsx::Pic</small> + + </li> + + + <li class="r2 "> <span class='object_link'><a href="Axlsx/CellStyle.html#hidden-instance_method" title="Axlsx::CellStyle#hidden (method)">#hidden</a></span> <small>Axlsx::CellStyle</small> @@ -1120,6 +1192,14 @@ </li> + <li class="r1 "> + <span class='object_link'><a href="Axlsx/CellProtection.html#hidden-instance_method" title="Axlsx::CellProtection#hidden (method)">#hidden</a></span> + + <small>Axlsx::CellProtection</small> + + </li> + + <li class="r2 "> <span class='object_link'><a href="Axlsx/CellAlignment.html#horizontal-instance_method" title="Axlsx::CellAlignment#horizontal (method)">#horizontal</a></span> @@ -1145,49 +1225,49 @@ <li class="r1 "> - <span class='object_link'><a href="Axlsx/CellAlignment.html#indent-instance_method" title="Axlsx::CellAlignment#indent (method)">#indent</a></span> + <span class='object_link'><a href="Axlsx/Pic.html#image_src-instance_method" title="Axlsx::Pic#image_src (method)">#image_src</a></span> - <small>Axlsx::CellAlignment</small> + <small>Axlsx::Pic</small> </li> <li class="r2 "> - <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/Drawing.html#images-instance_method" title="Axlsx::Drawing#images (method)">#images</a></span> - <small>Axlsx::TwoCellAnchor</small> + <small>Axlsx::Drawing</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/Workbook.html#images-instance_method" title="Axlsx::Workbook#images (method)">#images</a></span> - <small>Axlsx::Series</small> + <small>Axlsx::Workbook</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Chart.html#index-instance_method" title="Axlsx::Chart#index (method)">#index</a></span> + <span class='object_link'><a href="Axlsx/CellAlignment.html#indent-instance_method" title="Axlsx::CellAlignment#indent (method)">#indent</a></span> - <small>Axlsx::Chart</small> + <small>Axlsx::CellAlignment</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/Chart.html#index-instance_method" title="Axlsx::Chart#index (method)">#index</a></span> - <small>Axlsx::Drawing</small> + <small>Axlsx::Chart</small> </li> <li class="r2 "> - <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> @@ -1201,153 +1281,153 @@ <li class="r2 "> - <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/Worksheet.html#index-instance_method" title="Axlsx::Worksheet#index (method)">#index</a></span> - <small>Axlsx::Cell</small> + <small>Axlsx::Worksheet</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/App.html#initalize-instance_method" title="Axlsx::App#initalize (method)">#initalize</a></span> + <span class='object_link'><a href="Axlsx/Series.html#index-instance_method" title="Axlsx::Series#index (method)">#index</a></span> - <small>Axlsx::App</small> + <small>Axlsx::Series</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/OneCellAnchor.html#index-instance_method" title="Axlsx::OneCellAnchor#index (method)">#index</a></span> - <small>Axlsx::SerAxis</small> + <small>Axlsx::OneCellAnchor</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/Pic.html#index-instance_method" title="Axlsx::Pic#index (method)">#index</a></span> - <small>Axlsx::Fill</small> + <small>Axlsx::Pic</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/Drawing.html#index-instance_method" title="Axlsx::Drawing#index (method)">#index</a></span> - <small>Axlsx::TableStyles</small> + <small>Axlsx::Drawing</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/SimpleTypedList.html#initialize-instance_method" title="Axlsx::SimpleTypedList#initialize (method)">#initialize</a></span> + <span class='object_link'><a href="Axlsx/TwoCellAnchor.html#index-instance_method" title="Axlsx::TwoCellAnchor#index (method)">#index</a></span> - <small>Axlsx::SimpleTypedList</small> + <small>Axlsx::TwoCellAnchor</small> </li> <li class="r2 "> - <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/App.html#initalize-instance_method" title="Axlsx::App#initalize (method)">#initalize</a></span> - <small>Axlsx::Relationship</small> + <small>Axlsx::App</small> </li> <li class="r1 "> - <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/BarSeries.html#initialize-instance_method" title="Axlsx::BarSeries#initialize (method)">#initialize</a></span> - <small>Axlsx::CellStyle</small> + <small>Axlsx::BarSeries</small> </li> <li class="r2 "> - <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/Title.html#initialize-instance_method" title="Axlsx::Title#initialize (method)">#initialize</a></span> - <small>Axlsx::Bar3DChart</small> + <small>Axlsx::Title</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/SimpleTypedList.html#initialize-instance_method" title="Axlsx::SimpleTypedList#initialize (method)">#initialize</a></span> - <small>Axlsx::Marker</small> + <small>Axlsx::SimpleTypedList</small> </li> <li class="r2 "> - <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/Bar3DChart.html#initialize-instance_method" title="Axlsx::Bar3DChart#initialize (method)">#initialize</a></span> - <small>Axlsx::View3D</small> + <small>Axlsx::Bar3DChart</small> </li> <li class="r1 "> - <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/GradientStop.html#initialize-instance_method" title="Axlsx::GradientStop#initialize (method)">#initialize</a></span> - <small>Axlsx::Core</small> + <small>Axlsx::GradientStop</small> </li> <li class="r2 "> - <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/CatAxisData.html#initialize-instance_method" title="Axlsx::CatAxisData#initialize (method)">#initialize</a></span> - <small>Axlsx::TableStyle</small> + <small>Axlsx::CatAxisData</small> </li> <li class="r1 "> - <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/CatAxis.html#initialize-instance_method" title="Axlsx::CatAxis#initialize (method)">#initialize</a></span> - <small>Axlsx::Axis</small> + <small>Axlsx::CatAxis</small> </li> <li class="r2 "> - <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/ContentType.html#initialize-instance_method" title="Axlsx::ContentType#initialize (method)">#initialize</a></span> - <small>Axlsx::GradientStop</small> + <small>Axlsx::ContentType</small> </li> <li class="r1 "> - <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/Marker.html#initialize-instance_method" title="Axlsx::Marker#initialize (method)">#initialize</a></span> - <small>Axlsx::Pie3DChart</small> + <small>Axlsx::Marker</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/Xf.html#initialize-instance_method" title="Axlsx::Xf#initialize (method)">#initialize</a></span> - <small>Axlsx::CellProtection</small> + <small>Axlsx::Xf</small> </li> <li class="r1 "> - <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/Row.html#initialize-instance_method" title="Axlsx::Row#initialize (method)">#initialize</a></span> - <small>Axlsx::Xf</small> + <small>Axlsx::Row</small> </li> <li class="r2 "> - <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/LineSeries.html#initialize-instance_method" title="Axlsx::LineSeries#initialize (method)">#initialize</a></span> - <small>Axlsx::BarSeries</small> + <small>Axlsx::LineSeries</small> </li> @@ -1361,41 +1441,41 @@ <li class="r2 "> - <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="r1 "> - <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="r2 "> - <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/Font.html#initialize-instance_method" title="Axlsx::Font#initialize (method)">#initialize</a></span> - <small>Axlsx::Drawing</small> + <small>Axlsx::Font</small> </li> <li class="r1 "> - <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/TableStyleElement.html#initialize-instance_method" title="Axlsx::TableStyleElement#initialize (method)">#initialize</a></span> - <small>Axlsx::Series</small> + <small>Axlsx::TableStyleElement</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/Core.html#initialize-instance_method" title="Axlsx::Core#initialize (method)">#initialize</a></span> - <small>Axlsx::TwoCellAnchor</small> + <small>Axlsx::Core</small> </li> @@ -1409,25 +1489,25 @@ <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/Worksheet.html#initialize-instance_method" title="Axlsx::Worksheet#initialize (method)">#initialize</a></span> - <small>Axlsx::Default</small> + <small>Axlsx::Worksheet</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/CellProtection.html#initialize-instance_method" title="Axlsx::CellProtection#initialize (method)">#initialize</a></span> - <small>Axlsx::CatAxis</small> + <small>Axlsx::CellProtection</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/Pie3DChart.html#initialize-instance_method" title="Axlsx::Pie3DChart#initialize (method)">#initialize</a></span> - <small>Axlsx::Color</small> + <small>Axlsx::Pie3DChart</small> </li> @@ -1441,126 +1521,134 @@ <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/CellAlignment.html#initialize-instance_method" title="Axlsx::CellAlignment#initialize (method)">#initialize</a></span> - <small>Axlsx::PatternFill</small> + <small>Axlsx::CellAlignment</small> </li> <li class="r1 "> - <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/Pic.html#initialize-instance_method" title="Axlsx::Pic#initialize (method)">#initialize</a></span> - <small>Axlsx::CatAxisData</small> + <small>Axlsx::Pic</small> </li> <li class="r2 "> - <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/PieSeries.html#initialize-instance_method" title="Axlsx::PieSeries#initialize (method)">#initialize</a></span> - <small>Axlsx::Relationships</small> + <small>Axlsx::PieSeries</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/TableStyle.html#initialize-instance_method" title="Axlsx::TableStyle#initialize (method)">#initialize</a></span> - <small>Axlsx::Row</small> + <small>Axlsx::TableStyle</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/GraphicFrame.html#initialize-instance_method" title="Axlsx::GraphicFrame#initialize (method)">#initialize</a></span> - <small>Axlsx::Scaling</small> + <small>Axlsx::GraphicFrame</small> </li> <li class="r1 "> - <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/Line3DChart.html#initialize-instance_method" title="Axlsx::Line3DChart#initialize (method)">#initialize</a></span> - <small>Axlsx::Workbook</small> + <small>Axlsx::Line3DChart</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/BorderPr.html#initialize-instance_method" title="Axlsx::BorderPr#initialize (method)">#initialize</a></span> - <small>Axlsx::NumFmt</small> + <small>Axlsx::BorderPr</small> </li> <li class="r1 "> - <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/Drawing.html#initialize-instance_method" title="Axlsx::Drawing#initialize (method)">#initialize</a></span> - <small>Axlsx::CellAlignment</small> + <small>Axlsx::Drawing</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/Override.html#initialize-instance_method" title="Axlsx::Override#initialize (method)">#initialize</a></span> - <small>Axlsx::Title</small> + <small>Axlsx::Override</small> </li> <li class="r1 "> - <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/Styles.html#initialize-instance_method" title="Axlsx::Styles#initialize (method)">#initialize</a></span> - <small>Axlsx::Worksheet</small> + <small>Axlsx::Styles</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/Fill.html#initialize-instance_method" title="Axlsx::Fill#initialize (method)">#initialize</a></span> - <small>Axlsx::GraphicFrame</small> + <small>Axlsx::Fill</small> </li> <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/OneCellAnchor.html#initialize-instance_method" title="Axlsx::OneCellAnchor#initialize (method)">#initialize</a></span> - <small>Axlsx::Font</small> + <small>Axlsx::OneCellAnchor</small> </li> <li class="r2 "> - <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/View3D.html#initialize-instance_method" title="Axlsx::View3D#initialize (method)">#initialize</a></span> - <small>Axlsx::Styles</small> + <small>Axlsx::View3D</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/Workbook.html#initialize-instance_method" title="Axlsx::Workbook#initialize (method)">#initialize</a></span> - <small>Axlsx::ValAxis</small> + <small>Axlsx::Workbook</small> </li> <li class="r2 "> - <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/CellStyle.html#initialize-instance_method" title="Axlsx::CellStyle#initialize (method)">#initialize</a></span> - <small>Axlsx::PieSeries</small> + <small>Axlsx::CellStyle</small> </li> <li class="r1 "> + <span class='object_link'><a href="Axlsx/SerAxis.html#initialize-instance_method" title="Axlsx::SerAxis#initialize (method)">#initialize</a></span> + + <small>Axlsx::SerAxis</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> <small>Axlsx::Cell</small> @@ -1568,71 +1656,103 @@ </li> + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Relationship.html#initialize-instance_method" title="Axlsx::Relationship#initialize (method)">#initialize</a></span> + + <small>Axlsx::Relationship</small> + + </li> + + <li class="r2 "> - <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/Package.html#initialize-instance_method" title="Axlsx::Package#initialize (method)">#initialize</a></span> - <small>Axlsx::LineSeries</small> + <small>Axlsx::Package</small> </li> <li class="r1 "> - <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/ValAxis.html#initialize-instance_method" title="Axlsx::ValAxis#initialize (method)">#initialize</a></span> - <small>Axlsx::Override</small> + <small>Axlsx::ValAxis</small> </li> <li class="r2 "> - <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/PatternFill.html#initialize-instance_method" title="Axlsx::PatternFill#initialize (method)">#initialize</a></span> - <small>Axlsx::BorderPr</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/Series.html#initialize-instance_method" title="Axlsx::Series#initialize (method)">#initialize</a></span> - <small>Axlsx::ContentType</small> + <small>Axlsx::Series</small> </li> <li class="r2 "> - <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/Axis.html#initialize-instance_method" title="Axlsx::Axis#initialize (method)">#initialize</a></span> - <small>Axlsx::Line3DChart</small> + <small>Axlsx::Axis</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/CellAlignment.html#justifyLastLine-instance_method" title="Axlsx::CellAlignment#justifyLastLine (method)">#justifyLastLine</a></span> + <span class='object_link'><a href="Axlsx/TwoCellAnchor.html#initialize-instance_method" title="Axlsx::TwoCellAnchor#initialize (method)">#initialize</a></span> - <small>Axlsx::CellAlignment</small> + <small>Axlsx::TwoCellAnchor</small> </li> <li class="r2 "> - <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/Relationships.html#initialize-instance_method" title="Axlsx::Relationships#initialize (method)">#initialize</a></span> - <small>Axlsx::LineSeries</small> + <small>Axlsx::Relationships</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/BarSeries.html#labels-instance_method" title="Axlsx::BarSeries#labels (method)">#labels</a></span> + <span class='object_link'><a href="Axlsx/NumFmt.html#initialize-instance_method" title="Axlsx::NumFmt#initialize (method)">#initialize</a></span> - <small>Axlsx::BarSeries</small> + <small>Axlsx::NumFmt</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> + + <small>Axlsx::Color</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Scaling.html#initialize-instance_method" title="Axlsx::Scaling#initialize (method)">#initialize</a></span> + + <small>Axlsx::Scaling</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/CellAlignment.html#justifyLastLine-instance_method" title="Axlsx::CellAlignment#justifyLastLine (method)">#justifyLastLine</a></span> + + <small>Axlsx::CellAlignment</small> + + </li> + + + <li class="r1 "> <span class='object_link'><a href="Axlsx/PieSeries.html#labels-instance_method" title="Axlsx::PieSeries#labels (method)">#labels</a></span> <small>Axlsx::PieSeries</small> @@ -1640,7 +1760,23 @@ </li> + <li class="r2 "> + <span class='object_link'><a href="Axlsx/LineSeries.html#labels-instance_method" title="Axlsx::LineSeries#labels (method)">#labels</a></span> + + <small>Axlsx::LineSeries</small> + + </li> + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/BarSeries.html#labels-instance_method" title="Axlsx::BarSeries#labels (method)">#labels</a></span> + + <small>Axlsx::BarSeries</small> + + </li> + + + <li class="r2 "> <span class='object_link'><a href="Axlsx/CatAxis.html#lblAlgn-instance_method" title="Axlsx::CatAxis#lblAlgn (method)">#lblAlgn</a></span> <small>Axlsx::CatAxis</small> @@ -1648,7 +1784,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/CatAxis.html#lblOffset-instance_method" title="Axlsx::CatAxis#lblOffset (method)">#lblOffset</a></span> <small>Axlsx::CatAxis</small> @@ -1656,7 +1792,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/GradientFill.html#left-instance_method" title="Axlsx::GradientFill#left (method)">#left</a></span> <small>Axlsx::GradientFill</small> @@ -1664,7 +1800,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/SimpleTypedList.html#lock-instance_method" title="Axlsx::SimpleTypedList#lock (method)">#lock</a></span> <small>Axlsx::SimpleTypedList</small> @@ -1672,7 +1808,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/CellProtection.html#locked-instance_method" title="Axlsx::CellProtection#locked (method)">#locked</a></span> <small>Axlsx::CellProtection</small> @@ -1680,7 +1816,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/SimpleTypedList.html#locked_at-instance_method" title="Axlsx::SimpleTypedList#locked_at (method)">#locked_at</a></span> <small>Axlsx::SimpleTypedList</small> @@ -1688,7 +1824,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/Scaling.html#logBase-instance_method" title="Axlsx::Scaling#logBase (method)">#logBase</a></span> <small>Axlsx::Scaling</small> @@ -1696,7 +1832,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/Scaling.html#max-instance_method" title="Axlsx::Scaling#max (method)">#max</a></span> <small>Axlsx::Scaling</small> @@ -1704,7 +1840,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">#method_missing</a></span> <small>Axlsx::SimpleTypedList</small> @@ -1712,7 +1848,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/Scaling.html#min-instance_method" title="Axlsx::Scaling#min (method)">#min</a></span> <small>Axlsx::Scaling</small> @@ -1720,6 +1856,14 @@ </li> + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Worksheet.html#name-instance_method" title="Axlsx::Worksheet#name (method)">#name</a></span> + + <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> @@ -1729,33 +1873,33 @@ <li class="r2 "> - <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/BorderPr.html#name-instance_method" title="Axlsx::BorderPr#name (method)">#name</a></span> - <small>Axlsx::TableStyle</small> + <small>Axlsx::BorderPr</small> </li> <li class="r1 "> - <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/TableStyle.html#name-instance_method" title="Axlsx::TableStyle#name (method)">#name</a></span> - <small>Axlsx::Font</small> + <small>Axlsx::TableStyle</small> </li> <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/Pic.html#name-instance_method" title="Axlsx::Pic#name (method)">#name</a></span> - <small>Axlsx::Worksheet</small> + <small>Axlsx::Pic</small> </li> <li class="r1 "> - <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/Font.html#name-instance_method" title="Axlsx::Font#name (method)">#name</a></span> - <small>Axlsx::BorderPr</small> + <small>Axlsx::Font</small> </li> @@ -1785,6 +1929,22 @@ <li class="r1 "> + <span class='object_link'><a href="Axlsx/OneCellAnchor.html#object-instance_method" title="Axlsx::OneCellAnchor#object (method)">#object</a></span> + + <small>Axlsx::OneCellAnchor</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> + + <small>Axlsx::TwoCellAnchor</small> + + </li> + + + <li class="r1 "> <span class='object_link'><a href="Axlsx/Series.html#order-instance_method" title="Axlsx::Series#order (method)">#order</a></span> <small>Axlsx::Series</small> @@ -1801,17 +1961,17 @@ <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> <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> @@ -1857,17 +2017,17 @@ <li class="r2 "> - <span class='object_link'><a href="Axlsx/Worksheet.html#pn-instance_method" title="Axlsx::Worksheet#pn (method)">#pn</a></span> + <span class='object_link'><a href="Axlsx/Drawing.html#pn-instance_method" title="Axlsx::Drawing#pn (method)">#pn</a></span> - <small>Axlsx::Worksheet</small> + <small>Axlsx::Drawing</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Drawing.html#pn-instance_method" title="Axlsx::Drawing#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::Drawing</small> + <small>Axlsx::Pic</small> </li> @@ -1881,6 +2041,14 @@ <li class="r1 "> + <span class='object_link'><a href="Axlsx/Worksheet.html#pn-instance_method" title="Axlsx::Worksheet#pn (method)">#pn</a></span> + + <small>Axlsx::Worksheet</small> + + </li> + + + <li class="r2 "> <span class='object_link'><a href="Axlsx/GradientStop.html#position-instance_method" title="Axlsx::GradientStop#position (method)">#position</a></span> <small>Axlsx::GradientStop</small> @@ -1888,7 +2056,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/SimpleTypedList.html#protected%3F-instance_method" title="Axlsx::SimpleTypedList#protected? (method)">#protected?</a></span> <small>Axlsx::SimpleTypedList</small> @@ -1896,7 +2064,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/Xf.html#protection-instance_method" title="Axlsx::Xf#protection (method)">#protection</a></span> <small>Axlsx::Xf</small> @@ -1904,7 +2072,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/Border.html#prs-instance_method" title="Axlsx::Border#prs (method)">#prs</a></span> <small>Axlsx::Border</small> @@ -1912,7 +2080,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/SimpleTypedList.html#push-instance_method" title="Axlsx::SimpleTypedList#push (method)">#push</a></span> <small>Axlsx::SimpleTypedList</small> @@ -1920,7 +2088,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/Xf.html#quotePrefix-instance_method" title="Axlsx::Xf#quotePrefix (method)">#quotePrefix</a></span> <small>Axlsx::Xf</small> @@ -1928,7 +2096,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/Cell.html#r-instance_method" title="Axlsx::Cell#r (method)">#r</a></span> <small>Axlsx::Cell</small> @@ -1936,7 +2104,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/View3D.html#rAngAx-instance_method" title="Axlsx::View3D#rAngAx (method)">#rAngAx</a></span> <small>Axlsx::View3D</small> @@ -1944,7 +2112,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/Drawing.html#rId-instance_method" title="Axlsx::Drawing#rId (method)">#rId</a></span> <small>Axlsx::Drawing</small> @@ -1952,7 +2120,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/GraphicFrame.html#rId-instance_method" title="Axlsx::GraphicFrame#rId (method)">#rId</a></span> <small>Axlsx::GraphicFrame</small> @@ -1960,7 +2128,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/Worksheet.html#rId-instance_method" title="Axlsx::Worksheet#rId (method)">#rId</a></span> <small>Axlsx::Worksheet</small> @@ -1968,7 +2136,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/Cell.html#r_abs-instance_method" title="Axlsx::Cell#r_abs (method)">#r_abs</a></span> <small>Axlsx::Cell</small> @@ -1976,7 +2144,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/Title.html#range-instance_method" title="Axlsx::Title#range (method)">#range</a></span> <small>Axlsx::Title</small> @@ -1984,7 +2152,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/CellAlignment.html#readingOrder-instance_method" title="Axlsx::CellAlignment#readingOrder (method)">#readingOrder</a></span> <small>Axlsx::CellAlignment</small> @@ -1992,7 +2160,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/Worksheet.html#relationships-instance_method" title="Axlsx::Worksheet#relationships (method)">#relationships</a></span> <small>Axlsx::Worksheet</small> @@ -2000,15 +2168,15 @@ </li> - <li class="r2 "> - <span class='object_link'><a href="Axlsx/Drawing.html#relationships-instance_method" title="Axlsx::Drawing#relationships (method)">#relationships</a></span> + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Package.html#relationships-instance_method" title="Axlsx::Package#relationships (method)">#relationships</a></span> - <small>Axlsx::Drawing</small> + <small>Axlsx::Package</small> </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/Workbook.html#relationships-instance_method" title="Axlsx::Workbook#relationships (method)">#relationships</a></span> <small>Axlsx::Workbook</small> @@ -2016,15 +2184,15 @@ </li> - <li class="r2 "> - <span class='object_link'><a href="Axlsx/Package.html#relationships-instance_method" title="Axlsx::Package#relationships (method)">#relationships</a></span> + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Drawing.html#relationships-instance_method" title="Axlsx::Drawing#relationships (method)">#relationships</a></span> - <small>Axlsx::Package</small> + <small>Axlsx::Drawing</small> </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/CellAlignment.html#relativeIndent-instance_method" title="Axlsx::CellAlignment#relativeIndent (method)">#relativeIndent</a></span> <small>Axlsx::CellAlignment</small> @@ -2032,23 +2200,23 @@ </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> + <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> - <small>Axlsx::Drawing</small> + <small>Axlsx::Worksheet</small> </li> - <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> + <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> - <small>Axlsx::Worksheet</small> + <small>Axlsx::Drawing</small> </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/Color.html#rgb-instance_method" title="Axlsx::Color#rgb (method)">#rgb</a></span> <small>Axlsx::Color</small> @@ -2056,7 +2224,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/GradientFill.html#right-instance_method" title="Axlsx::GradientFill#right (method)">#right</a></span> <small>Axlsx::GradientFill</small> @@ -2064,7 +2232,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/View3D.html#rotX-instance_method" title="Axlsx::View3D#rotX (method)">#rotX</a></span> <small>Axlsx::View3D</small> @@ -2072,7 +2240,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/View3D.html#rotY-instance_method" title="Axlsx::View3D#rotY (method)">#rotY</a></span> <small>Axlsx::View3D</small> @@ -2080,7 +2248,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/Cell.html#row-instance_method" title="Axlsx::Cell#row (method)">#row</a></span> <small>Axlsx::Cell</small> @@ -2088,7 +2256,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/Marker.html#row-instance_method" title="Axlsx::Marker#row (method)">#row</a></span> <small>Axlsx::Marker</small> @@ -2096,7 +2264,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/Marker.html#rowOff-instance_method" title="Axlsx::Marker#rowOff (method)">#rowOff</a></span> <small>Axlsx::Marker</small> @@ -2104,7 +2272,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/Worksheet.html#rows-instance_method" title="Axlsx::Worksheet#rows (method)">#rows</a></span> <small>Axlsx::Worksheet</small> @@ -2112,7 +2280,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/Axis.html#scaling-instance_method" title="Axlsx::Axis#scaling (method)">#scaling</a></span> <small>Axlsx::Axis</small> @@ -2120,7 +2288,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/Line3DChart.html#serAxis-instance_method" title="Axlsx::Line3DChart#serAxis (method)">#serAxis</a></span> <small>Axlsx::Line3DChart</small> @@ -2128,7 +2296,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/Package.html#serialize-instance_method" title="Axlsx::Package#serialize (method)">#serialize</a></span> <small>Axlsx::Package</small> @@ -2136,7 +2304,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/SimpleTypedList.html#serialize_as-instance_method" title="Axlsx::SimpleTypedList#serialize_as (method)">#serialize_as</a></span> <small>Axlsx::SimpleTypedList</small> @@ -2144,7 +2312,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/Chart.html#series-instance_method" title="Axlsx::Chart#series (method)">#series</a></span> <small>Axlsx::Chart</small> @@ -2152,7 +2320,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/Chart.html#series_type-instance_method" title="Axlsx::Chart#series_type (method)">#series_type</a></span> <small>Axlsx::Chart</small> @@ -2160,7 +2328,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/Font.html#shadow-instance_method" title="Axlsx::Font#shadow (method)">#shadow</a></span> <small>Axlsx::Font</small> @@ -2168,7 +2336,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/Bar3DChart.html#shape-instance_method" title="Axlsx::Bar3DChart#shape (method)">#shape</a></span> <small>Axlsx::Bar3DChart</small> @@ -2176,7 +2344,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/BarSeries.html#shape-instance_method" title="Axlsx::BarSeries#shape (method)">#shape</a></span> <small>Axlsx::BarSeries</small> @@ -2184,7 +2352,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/Chart.html#show_legend-instance_method" title="Axlsx::Chart#show_legend (method)">#show_legend</a></span> <small>Axlsx::Chart</small> @@ -2192,7 +2360,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/CellAlignment.html#shrinkToFit-instance_method" title="Axlsx::CellAlignment#shrinkToFit (method)">#shrinkToFit</a></span> <small>Axlsx::CellAlignment</small> @@ -2200,7 +2368,7 @@ </li> - <li class="r1 "> + <li class="r2 "> <span class='object_link'><a href="Axlsx/TableStyleElement.html#size-instance_method" title="Axlsx::TableStyleElement#size (method)">#size</a></span> <small>Axlsx::TableStyleElement</small> @@ -2208,7 +2376,7 @@ </li> - <li class="r2 "> + <li class="r1 "> <span class='object_link'><a href="Axlsx/Chart.html#start_at-instance_method" title="Axlsx::Chart#start_at (method)">#start_at</a></span> <small>Axlsx::Chart</small> @@ -2216,6 +2384,14 @@ </li> + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Pic.html#start_at-instance_method" title="Axlsx::Pic#start_at (method)">#start_at</a></span> + + <small>Axlsx::Pic</small> + + </li> + + <li class="r1 "> <span class='object_link'><a href="Axlsx/GradientFill.html#stop-instance_method" title="Axlsx::GradientFill#stop (method)">#stop</a></span> @@ -2233,25 +2409,25 @@ <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> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Cell.html#style-instance_method" title="Axlsx::Cell#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::Cell</small> + <small>Axlsx::BorderPr</small> </li> <li class="r1 "> - <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/Cell.html#style-instance_method" title="Axlsx::Cell#style (method)">#style</a></span> - <small>Axlsx::Chart</small> + <small>Axlsx::Cell</small> </li> @@ -2353,153 +2529,153 @@ <li class="r2 "> - <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/TwoCellAnchor.html#to-instance_method" title="Axlsx::TwoCellAnchor#to (method)">#to</a></span> - <small>Axlsx::Chart</small> + <small>Axlsx::TwoCellAnchor</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/TwoCellAnchor.html#to-instance_method" title="Axlsx::TwoCellAnchor#to (method)">#to</a></span> + <span class='object_link'><a href="Axlsx/Chart.html#to-instance_method" title="Axlsx::Chart#to (method)">#to</a></span> - <small>Axlsx::TwoCellAnchor</small> + <small>Axlsx::Chart</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/SimpleTypedList.html#to_xml-instance_method" title="Axlsx::SimpleTypedList#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::SimpleTypedList</small> + <small>Axlsx::GradientStop</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/TableStyles.html#to_xml-instance_method" title="Axlsx::TableStyles#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Drawing</small> + <small>Axlsx::TableStyles</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/Cell.html#to_xml-instance_method" title="Axlsx::Cell#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Relationship</small> + <small>Axlsx::Cell</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/OneCellAnchor.html#to_xml-instance_method" title="Axlsx::OneCellAnchor#to_xml (method)">#to_xml</a></span> - <small>Axlsx::CellStyle</small> + <small>Axlsx::OneCellAnchor</small> </li> <li class="r2 "> - <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/Marker.html#to_xml-instance_method" title="Axlsx::Marker#to_xml (method)">#to_xml</a></span> - <small>Axlsx::View3D</small> + <small>Axlsx::Marker</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Bar3DChart.html#to_xml-instance_method" title="Axlsx::Bar3DChart#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::Bar3DChart</small> + <small>Axlsx::Row</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/ContentType.html#to_xml-instance_method" title="Axlsx::ContentType#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Fill</small> + <small>Axlsx::ContentType</small> </li> <li class="r1 "> - <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/Title.html#to_xml-instance_method" title="Axlsx::Title#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Default</small> + <small>Axlsx::Title</small> </li> <li class="r2 "> - <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/CatAxisData.html#to_xml-instance_method" title="Axlsx::CatAxisData#to_xml (method)">#to_xml</a></span> - <small>Axlsx::App</small> + <small>Axlsx::CatAxisData</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Core.html#to_xml-instance_method" title="Axlsx::Core#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::Core</small> + <small>Axlsx::Pie3DChart</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/Override.html#to_xml-instance_method" title="Axlsx::Override#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Row</small> + <small>Axlsx::Override</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Axis.html#to_xml-instance_method" title="Axlsx::Axis#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::Axis</small> + <small>Axlsx::Default</small> </li> <li class="r2 "> - <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/Border.html#to_xml-instance_method" title="Axlsx::Border#to_xml (method)">#to_xml</a></span> - <small>Axlsx::BorderPr</small> + <small>Axlsx::Border</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/Font.html#to_xml-instance_method" title="Axlsx::Font#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Relationships</small> + <small>Axlsx::Font</small> </li> <li class="r2 "> - <span class='object_link'><a href="Axlsx/Series.html#to_xml-instance_method" title="Axlsx::Series#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::Series</small> + <small>Axlsx::Styles</small> </li> <li class="r1 "> - <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/GraphicFrame.html#to_xml-instance_method" title="Axlsx::GraphicFrame#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Override</small> + <small>Axlsx::GraphicFrame</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/View3D.html#to_xml-instance_method" title="Axlsx::View3D#to_xml (method)">#to_xml</a></span> - <small>Axlsx::PatternFill</small> + <small>Axlsx::View3D</small> </li> @@ -2513,185 +2689,185 @@ <li class="r2 "> - <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/CellAlignment.html#to_xml-instance_method" title="Axlsx::CellAlignment#to_xml (method)">#to_xml</a></span> - <small>Axlsx::GraphicFrame</small> + <small>Axlsx::CellAlignment</small> </li> <li class="r1 "> - <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/Scaling.html#to_xml-instance_method" title="Axlsx::Scaling#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Font</small> + <small>Axlsx::Scaling</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/PieSeries.html#to_xml-instance_method" title="Axlsx::PieSeries#to_xml (method)">#to_xml</a></span> - <small>Axlsx::BarSeries</small> + <small>Axlsx::PieSeries</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Worksheet.html#to_xml-instance_method" title="Axlsx::Worksheet#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::Worksheet</small> + <small>Axlsx::ValAxisData</small> </li> <li class="r2 "> - <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/SerAxis.html#to_xml-instance_method" title="Axlsx::SerAxis#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Pie3DChart</small> + <small>Axlsx::SerAxis</small> </li> <li class="r1 "> - <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/Line3DChart.html#to_xml-instance_method" title="Axlsx::Line3DChart#to_xml (method)">#to_xml</a></span> - <small>Axlsx::SeriesTitle</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/ValAxis.html#to_xml-instance_method" title="Axlsx::ValAxis#to_xml (method)">#to_xml</a></span> - <small>Axlsx::TableStyles</small> + <small>Axlsx::ValAxis</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/PatternFill.html#to_xml-instance_method" title="Axlsx::PatternFill#to_xml (method)">#to_xml</a></span> - <small>Axlsx::ContentType</small> + <small>Axlsx::PatternFill</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/GradientFill.html#to_xml-instance_method" title="Axlsx::GradientFill#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::GradientFill</small> + <small>Axlsx::Series</small> </li> <li class="r2 "> - <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/Relationship.html#to_xml-instance_method" title="Axlsx::Relationship#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Line3DChart</small> + <small>Axlsx::Relationship</small> </li> <li class="r1 "> - <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/Relationships.html#to_xml-instance_method" title="Axlsx::Relationships#to_xml (method)">#to_xml</a></span> - <small>Axlsx::LineSeries</small> + <small>Axlsx::Relationships</small> </li> <li class="r2 "> - <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/CellStyle.html#to_xml-instance_method" title="Axlsx::CellStyle#to_xml (method)">#to_xml</a></span> - <small>Axlsx::ValAxis</small> + <small>Axlsx::CellStyle</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/Xf.html#to_xml-instance_method" title="Axlsx::Xf#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Chart</small> + <small>Axlsx::Xf</small> </li> <li class="r2 "> - <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/Fill.html#to_xml-instance_method" title="Axlsx::Fill#to_xml (method)">#to_xml</a></span> - <small>Axlsx::TwoCellAnchor</small> + <small>Axlsx::Fill</small> </li> <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/Axis.html#to_xml-instance_method" title="Axlsx::Axis#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Workbook</small> + <small>Axlsx::Axis</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/NumFmt.html#to_xml-instance_method" title="Axlsx::NumFmt#to_xml (method)">#to_xml</a></span> - <small>Axlsx::CellAlignment</small> + <small>Axlsx::NumFmt</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/Chart.html#to_xml-instance_method" title="Axlsx::Chart#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Scaling</small> + <small>Axlsx::Chart</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/CatAxis.html#to_xml-instance_method" title="Axlsx::CatAxis#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Title</small> + <small>Axlsx::CatAxis</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/Worksheet.html#to_xml-instance_method" title="Axlsx::Worksheet#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Cell</small> + <small>Axlsx::Worksheet</small> </li> <li class="r2 "> - <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/BorderPr.html#to_xml-instance_method" title="Axlsx::BorderPr#to_xml (method)">#to_xml</a></span> - <small>Axlsx::CatAxisData</small> + <small>Axlsx::BorderPr</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/SeriesTitle.html#to_xml-instance_method" title="Axlsx::SeriesTitle#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Marker</small> + <small>Axlsx::SeriesTitle</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/Color.html#to_xml-instance_method" title="Axlsx::Color#to_xml (method)">#to_xml</a></span> - <small>Axlsx::GradientStop</small> + <small>Axlsx::Color</small> </li> @@ -2705,73 +2881,89 @@ <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/SimpleTypedList.html#to_xml-instance_method" title="Axlsx::SimpleTypedList#to_xml (method)">#to_xml</a></span> - <small>Axlsx::SerAxis</small> + <small>Axlsx::SimpleTypedList</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/Core.html#to_xml-instance_method" title="Axlsx::Core#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Styles</small> + <small>Axlsx::Core</small> </li> <li class="r2 "> - <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/TableStyleElement.html#to_xml-instance_method" title="Axlsx::TableStyleElement#to_xml (method)">#to_xml</a></span> - <small>Axlsx::PieSeries</small> + <small>Axlsx::TableStyleElement</small> </li> <li class="r1 "> - <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/LineSeries.html#to_xml-instance_method" title="Axlsx::LineSeries#to_xml (method)">#to_xml</a></span> - <small>Axlsx::CatAxis</small> + <small>Axlsx::LineSeries</small> </li> <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/BarSeries.html#to_xml-instance_method" title="Axlsx::BarSeries#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Xf</small> + <small>Axlsx::BarSeries</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/GradientFill.html#to_xml-instance_method" title="Axlsx::GradientFill#to_xml (method)">#to_xml</a></span> - <small>Axlsx::NumFmt</small> + <small>Axlsx::GradientFill</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/Workbook.html#to_xml-instance_method" title="Axlsx::Workbook#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Color</small> + <small>Axlsx::Workbook</small> </li> <li class="r1 "> - <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/App.html#to_xml-instance_method" title="Axlsx::App#to_xml (method)">#to_xml</a></span> - <small>Axlsx::TableStyleElement</small> + <small>Axlsx::App</small> </li> <li class="r2 "> - <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/TwoCellAnchor.html#to_xml-instance_method" title="Axlsx::TwoCellAnchor#to_xml (method)">#to_xml</a></span> - <small>Axlsx::Border</small> + <small>Axlsx::TwoCellAnchor</small> + + </li> + + + <li class="r1 "> + <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> + + </li> + + + <li class="r2 "> + <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::Pic</small> </li> @@ -2785,9 +2977,9 @@ <li class="r2 "> - <span class='object_link'><a href="Axlsx/GradientFill.html#type-instance_method" title="Axlsx::GradientFill#type (method)">#type</a></span> + <span class='object_link'><a href="Axlsx/Cell.html#type-instance_method" title="Axlsx::Cell#type (method)">#type</a></span> - <small>Axlsx::GradientFill</small> + <small>Axlsx::Cell</small> </li> @@ -2801,9 +2993,9 @@ <li class="r2 "> - <span class='object_link'><a href="Axlsx/Cell.html#type-instance_method" title="Axlsx::Cell#type (method)">#type</a></span> + <span class='object_link'><a href="Axlsx/GradientFill.html#type-instance_method" title="Axlsx::GradientFill#type (method)">#type</a></span> - <small>Axlsx::Cell</small> + <small>Axlsx::GradientFill</small> </li> @@ -2841,33 +3033,33 @@ <li class="r1 "> - <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/RestrictionValidator.html#validate-class_method" title="Axlsx::RestrictionValidator.validate (method)">validate</a></span> - <small>Axlsx::Package</small> + <small>Axlsx::RestrictionValidator</small> </li> <li class="r2 "> - <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/RegexValidator.html#validate-class_method" title="Axlsx::RegexValidator.validate (method)">validate</a></span> - <small>Axlsx::RestrictionValidator</small> + <small>Axlsx::RegexValidator</small> </li> <li class="r1 "> - <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/DataTypeValidator.html#validate-class_method" title="Axlsx::DataTypeValidator.validate (method)">validate</a></span> - <small>Axlsx::RegexValidator</small> + <small>Axlsx::DataTypeValidator</small> </li> <li class="r2 "> - <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> @@ -3001,30 +3193,38 @@ <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/OneCellAnchor.html#width-instance_method" title="Axlsx::OneCellAnchor#width (method)">#width</a></span> - <small>Axlsx::Worksheet</small> + <small>Axlsx::OneCellAnchor</small> </li> <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/Pic.html#width-instance_method" title="Axlsx::Pic#width (method)">#width</a></span> - <small>Axlsx::Package</small> + <small>Axlsx::Pic</small> </li> <li class="r1 "> - <span class='object_link'><a href="Axlsx/Row.html#worksheet-instance_method" title="Axlsx::Row#worksheet (method)">#worksheet</a></span> + <span class='object_link'><a href="Axlsx/Package.html#workbook-instance_method" title="Axlsx::Package#workbook (method)">#workbook</a></span> - <small>Axlsx::Row</small> + <small>Axlsx::Package</small> </li> <li class="r2 "> + <span class='object_link'><a href="Axlsx/Worksheet.html#workbook-instance_method" title="Axlsx::Worksheet#workbook (method)">#workbook</a></span> + + <small>Axlsx::Worksheet</small> + + </li> + + + <li class="r1 "> <span class='object_link'><a href="Axlsx/Drawing.html#worksheet-instance_method" title="Axlsx::Drawing#worksheet (method)">#worksheet</a></span> <small>Axlsx::Drawing</small> @@ -3032,6 +3232,14 @@ </li> + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Row.html#worksheet-instance_method" title="Axlsx::Row#worksheet (method)">#worksheet</a></span> + + <small>Axlsx::Row</small> + + </li> + + <li class="r1 "> <span class='object_link'><a href="Axlsx/Workbook.html#worksheets-instance_method" title="Axlsx::Workbook#worksheets (method)">#worksheets</a></span> diff --git a/doc/top-level-namespace.html b/doc/top-level-namespace.html index 61239b8e..b323bcd6 100644 --- a/doc/top-level-namespace.html +++ b/doc/top-level-namespace.html @@ -94,7 +94,7 @@ </div> <div id="footer"> - Generated on Wed Nov 23 12:36:48 2011 by + Generated on Wed Nov 23 21:44:52 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> diff --git a/examples/example.rb b/examples/example.rb index cb405fe2..15b2205c 100644 --- a/examples/example.rb +++ b/examples/example.rb @@ -82,5 +82,18 @@ chart.add_series :data=>sheet.rows.first.cells[(1..-1)], :title=> sheet.rows.first.cells.first chart.add_series :data=>sheet.rows.last.cells[(1..-1)], :title=> sheet.rows.last.cells.first end + end p.serialize("example6.xlsx") + +#Add an Image + + p = Axlsx::Package.new + p.workbook.add_worksheet do |sheet| + sheet.add_image(:image_src => (File.dirname(__FILE__) + "/image1.png")) do |image| + image.width=720 + image.height=666 + image.start_at 2, 2 + end + end + p.serialize("example7.xlsx") diff --git a/examples/image1.gif b/examples/image1.gif Binary files differnew file mode 100644 index 00000000..06d56d2b --- /dev/null +++ b/examples/image1.gif diff --git a/examples/image1.jpeg b/examples/image1.jpeg Binary files differnew file mode 100644 index 00000000..ce1d0c56 --- /dev/null +++ b/examples/image1.jpeg diff --git a/examples/image1.jpg b/examples/image1.jpg Binary files differnew file mode 100644 index 00000000..25efc268 --- /dev/null +++ b/examples/image1.jpg diff --git a/examples/image1.png b/examples/image1.png Binary files differnew file mode 100644 index 00000000..20d9e3b8 --- /dev/null +++ b/examples/image1.png diff --git a/lib/axlsx/drawing/bar_series.rb b/lib/axlsx/drawing/bar_series.rb index 5e10eb0e..c4bffa8c 100644 --- a/lib/axlsx/drawing/bar_series.rb +++ b/lib/axlsx/drawing/bar_series.rb @@ -51,7 +51,6 @@ module Axlsx private - # assigns the data for this series def data=(v) DataTypeValidator.validate "Series.data", [SimpleTypedList], v; @data = v; end diff --git a/lib/axlsx/drawing/cat_axis_data.rb b/lib/axlsx/drawing/cat_axis_data.rb index 83dfa56e..60e6ee9d 100644 --- a/lib/axlsx/drawing/cat_axis_data.rb +++ b/lib/axlsx/drawing/cat_axis_data.rb @@ -7,6 +7,7 @@ module Axlsx def initialize(data=[]) super Object @list.concat data if data.is_a?(Array) + data.each { |i| @list << i } if data.is_a?(SimpleTypedList) end # Serializes the category axis data diff --git a/lib/axlsx/drawing/chart.rb b/lib/axlsx/drawing/chart.rb index bf4a1bff..6be9cbfe 100644 --- a/lib/axlsx/drawing/chart.rb +++ b/lib/axlsx/drawing/chart.rb @@ -90,7 +90,6 @@ module Axlsx # backwards compatibility to allow chart.to and chart.from access to anchor markers # @note This will be disconinued in version 2.0.0. please use the start_at method - # def from @graphic_frame.anchor.from end diff --git a/lib/axlsx/drawing/drawing.rb b/lib/axlsx/drawing/drawing.rb index 385cd592..17347cd1 100644 --- a/lib/axlsx/drawing/drawing.rb +++ b/lib/axlsx/drawing/drawing.rb @@ -16,6 +16,8 @@ module Axlsx require 'axlsx/drawing/val_axis_data.rb' require 'axlsx/drawing/marker.rb' + + require 'axlsx/drawing/one_cell_anchor.rb' require 'axlsx/drawing/two_cell_anchor.rb' require 'axlsx/drawing/graphic_frame.rb' @@ -25,6 +27,9 @@ module Axlsx require 'axlsx/drawing/bar_3D_chart.rb' require 'axlsx/drawing/line_3D_chart.rb' + + require 'axlsx/drawing/pic.rb' + # 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. # @note The recommended way to manage drawings is to use the Worksheet.add_chart method. @@ -46,6 +51,10 @@ module Axlsx # @return [Array] attr_reader :charts + # An array of image objects that are associated with this drawing's anchors + # @return [Array] + attr_reader :images + # The index of this drawing in the owning workbooks's drawings collection. # @return [Integer] attr_reader :index @@ -72,20 +81,33 @@ module Axlsx DataTypeValidator.validate "Drawing.worksheet", Worksheet, worksheet @worksheet = worksheet @worksheet.workbook.drawings << self - @anchors = SimpleTypedList.new TwoCellAnchor + @anchors = SimpleTypedList.new [TwoCellAnchor, OneCellAnchor] + end + + # Adds an image to the chart + # @note The recommended way to manage images is to use Worksheet.add_image. Please refer to that method for documentation. + # @see Worksheet#add_image + def add_image(options={}) + OneCellAnchor.new(self, options) + @anchors.last.object end - # Adds a chart to the drawing. # @note The recommended way to manage charts is to use Worksheet.add_chart. Please refer to that method for documentation. # @see Worksheet#add_chart def add_chart(chart_type, options={}) - TwoCellAnchor.new(self, chart_type, options) - @anchors.last.graphic_frame.chart + TwoCellAnchor.new(self, options) + @anchors.last.add_chart(chart_type, options) end def charts - @anchors.map { |a| a.graphic_frame.chart } + charts = @anchors.select { |a| a.object.is_a?(GraphicFrame) } + charts.map { |a| a.object.chart } + end + + def images + images = @anchors.select { |a| a.object.is_a?(Pic) } + images.map { |a| a.object } end def index @@ -106,10 +128,12 @@ module Axlsx def relationships r = Relationships.new - @anchors.each do |anchor| - chart = anchor.graphic_frame.chart + charts.each do |chart| r << Relationship.new(CHART_R, "../#{chart.pn}") end + images.each do |image| + r << Relationship.new(IMAGE_R, "../#{image.pn}") + end r end diff --git a/lib/axlsx/drawing/graphic_frame.rb b/lib/axlsx/drawing/graphic_frame.rb index 5e09fb8a..e8e5ba21 100644 --- a/lib/axlsx/drawing/graphic_frame.rb +++ b/lib/axlsx/drawing/graphic_frame.rb @@ -4,8 +4,6 @@ module Axlsx # @see Worksheet#add_chart class GraphicFrame - #TODO add in support for other graphical objects, primarily images. - # A reference to the chart object associated with this frame # @return [Chart] attr_reader :chart diff --git a/lib/axlsx/drawing/line_series.rb b/lib/axlsx/drawing/line_series.rb index eea1e0ee..40beeb84 100644 --- a/lib/axlsx/drawing/line_series.rb +++ b/lib/axlsx/drawing/line_series.rb @@ -26,7 +26,6 @@ module Axlsx # Serializes the series # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to. # @return [String] - # TODO create series_cat and series_val classes as this serialization is duplicated def to_xml(xml) super(xml) do |xml| @labels.to_xml(xml) unless @labels.nil? diff --git a/lib/axlsx/drawing/one_cell_anchor.rb b/lib/axlsx/drawing/one_cell_anchor.rb new file mode 100644 index 00000000..caa0edae --- /dev/null +++ b/lib/axlsx/drawing/one_cell_anchor.rb @@ -0,0 +1,89 @@ +module Axlsx + # This class details a single cell anchor for drawings. + # @note The recommended way to manage drawings, images and charts is Worksheet#add_chart or Worksheet#add_image. + # @see Worksheet#add_chart + # @see Worksheet#add_image + class OneCellAnchor + + # A marker that defines the from cell anchor. The default from column and row are 0 and 0 respectively + # @return [Marker] + attr_reader :from + + # The object this anchor hosts + # @return [Pic] + attr_reader :object + + # The drawing that holds this anchor + # @return [Drawing] + attr_reader :drawing + + # The index of this anchor in the drawing + # @return [Integer] + attr_reader :index + + + # the width of the graphic object in pixels. + # this is converted to EMU at a 92 ppi resolution + # @return [Integer] + attr_accessor :width + + # the height of the graphic object in pixels + # this is converted to EMU at a 92 ppi resolution + # @return [Integer] + attr_accessor :height + + + # Creates a new OneCellAnchor object and an Pic associated with it. + # @param [Drawing] drawing + # @option options [Array] start_at the col, row to start at + # @option options [Integer] width + # @option options [Integer] height + # @option options [String] image_src the file location of the image you will render + # @option options [String] name the name attribute for the rendered image + # @option options [String] descr the description of the image rendered + def initialize(drawing, options={}) + @drawing = drawing + @width = 0 + @height = 0 + drawing.anchors << self + @from = Marker.new + options.each do |o| + self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}=" + end + @object = Pic.new(self, options) + end + + def height=(v) Axlsx::validate_unsigned_int(v); @height = v; end + def width=(v) Axlsx::validate_unsigned_int(v); @width = v; end + + def index + @drawing.anchors.index(self) + end + + # Serializes the anchor + # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to. + # @return [String] + def to_xml(xml) + xml.send('xdr:oneCellAnchor') { + xml.send('xdr:from') { + from.to_xml(xml) + } + xml.send('xdr:ext', ext) + @object.to_xml(xml) + xml.send('xdr:clientData') + } + end + + private + + # converts the pixel width and height to EMU units and returns a hash of + # !{:cx=>[Integer], :cy=>[Integer] + # @return [Hash] + def ext + cy = @height * 914400 / 96 + cx = @width * 914400 / 96 + {:cy=>cy, :cx=>cx} + end + + end +end diff --git a/lib/axlsx/drawing/pic.rb b/lib/axlsx/drawing/pic.rb new file mode 100644 index 00000000..7043df35 --- /dev/null +++ b/lib/axlsx/drawing/pic.rb @@ -0,0 +1,158 @@ +# -*- coding: utf-8 -*- +module Axlsx + # a Pic object represents an image in your worksheet + # Worksheet#add_image is the recommended way to manage images in your sheets + # @see Worksheet#add_image + class Pic + + # allowed file extenstions + ALLOWED_EXTENSIONS = ['gif', 'jpeg', 'png', 'jpg'] + + # The name to use for this picture + # @return [String] + attr_accessor :name + + # providing access to the anchor's width attribute + # @param [Integer] v + # @see OneCellAnchor.width + attr_accessor :width + + # providing access to update the anchor's height attribute + # @param [Integer] v + # @see OneCellAnchor.width + attr_accessor :height + + # A description of the picture + # @return [String] + attr_accessor :descr + + # The path to the image you want to include + # Only local images are supported at this time and only jpg support + # @return [String] + attr_accessor :image_src + + # The anchor for this image + # @return [OneCellAnchor] + attr_reader :anchor + + # returns the extension of image_src without the preceeding '.' + # @return [String] + attr_reader :extname + + # The file name of image_src without any path information + # @return [String] + attr_reader :file_name + + # The part name for this image used in serialization and relationship building + # @return [String] + attr_reader :pn + + # The index of this image in the workbooks images collections + # @return [Index] + attr_reader :index + + # The name of the image file, sans directory info + # @return [String] + attr_reader :file_name + + # Creates a new Pic(ture) object + # @param [Anchor] anchor the anchor that holds this image + # @option options [String] name + # @option options [String] descr + # @option options [String] image_src + # @option options [Array] start_at + # @option options [Intger] width + # @option options [Intger] height + def initialize(anchor, options={}) + @anchor = anchor + @anchor.drawing.worksheet.workbook.images << self + options.each do |o| + self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}=" + end + start_at *options[:start_at] if options[:start_at] + yield self if block_given? + end + + def image_src=(v) + Axlsx::validate_string(v) + RestrictionValidator.validate 'Pic.image_src', ALLOWED_EXTENSIONS, File.extname(v).delete('.') + raise ArgumentError, "File does not exist" unless File.exist?(v) + @image_src = v + end + + def name=(v) Axlsx::validate_string(v); @name = v; end + def descr=(v) Axlsx::validate_string(v); @descr = v; end + + def file_name + File.basename(image_src) unless image_src.nil? + end + + def extname + File.extname(image_src).delete('.') unless image_src.nil? + end + + def index + @anchor.drawing.worksheet.workbook.images.index(self) + end + + def pn + "#{IMAGE_PN % [(index+1), extname]}" + end + + def width + @anchor.width + end + + def width=(v) + @anchor.width = v + end + + def height=(v) + @anchor.height = v + end + + def height + @anchor.height + end + + # 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 + # @param [Integer] x The column + # @param [Integer] y The row + # @return [Marker] + def start_at(x, y) + @anchor.from.col = x + @anchor.from.row = y + end + + # Serializes the picture + # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to. + # @return [String] + def to_xml(xml) + xml.send('xdr:pic') { + xml.send('xdr:nvPicPr') { + xml.send('xdr:cNvPr', :id=>"2", :name=>name, :descr=>descr) + xml.send('xdr:cNvPicPr') { + xml.send('a:picLocks', :noChangeAspect=>1) + } + } + xml.send('xdr:blipFill') { + xml.send('a:blip', :'xmlns:r' => XML_NS_R, :'r:embed'=>"rId1") + xml.send('a:stretch') { + xml.send('a:fillRect') + } + } + xml.send('xdr:spPr') { + xml.send('a:xfrm') { + xml.send('a:off', :x=>0, :y=>0) + xml.send('a:ext', :cx=>2336800, :cy=>2161540) + } + xml.send('a:prstGeom', :prst=>:rect) { + xml.send('a:avLst') + } + } + } + end + end +end diff --git a/lib/axlsx/drawing/pie_3D_chart.rb b/lib/axlsx/drawing/pie_3D_chart.rb index dacba313..3cd6e377 100644 --- a/lib/axlsx/drawing/pie_3D_chart.rb +++ b/lib/axlsx/drawing/pie_3D_chart.rb @@ -25,7 +25,6 @@ module Axlsx super(frame, options) @series_type = PieSeries @view3D = View3D.new({:rotX=>30, :perspective=>30}.merge(options)) - end # Serializes the pie chart diff --git a/lib/axlsx/drawing/two_cell_anchor.rb b/lib/axlsx/drawing/two_cell_anchor.rb index 62491b8c..73e2fe20 100644 --- a/lib/axlsx/drawing/two_cell_anchor.rb +++ b/lib/axlsx/drawing/two_cell_anchor.rb @@ -12,8 +12,13 @@ module Axlsx attr_reader :to # The frame for your chart + # @note this will be discontinued in version 2.0 please use object # @return [GraphicFrame] - attr_reader :graphic_frame + # attr_reader :graphic_frame + + # The object this anchor hosts + # @return [Pic, GraphicFrame] + attr_reader :object # The drawing that holds this anchor # @return [Drawing] @@ -27,15 +32,23 @@ module Axlsx # graphic_frame's chart. That means that you can do stuff like # c = worksheet.add_chart Axlsx::Chart # c.start_at 5, 9 + # @note the chart_type parameter will be replaced with object in v. 2.0.0 # @param [Drawing] drawing # @param [Class] chart_type This is passed to the graphic frame for instantiation. must be Chart or a subclass of Chart + # @param object The object this anchor holds. # @option options [Array] start_at the col, row to start at # @option options [Array] end_at the col, row to end at - def initialize(drawing, chart_type, options) + def initialize(drawing, options={}) @drawing = drawing drawing.anchors << self @from, @to = Marker.new, Marker.new(:col => 5, :row=>10) - @graphic_frame = GraphicFrame.new(self, chart_type, options) + end + + # Creates a graphic frame and chart object associated with this anchor + # @return [Chart] + def add_chart(chart_type, options) + @object = GraphicFrame.new(self, chart_type, options) + @object.chart end def index @@ -53,7 +66,7 @@ module Axlsx xml.send('xdr:to') { to.to_xml(xml) } - @graphic_frame.to_xml(xml) + @object.to_xml(xml) xml.send('xdr:clientData') } end diff --git a/lib/axlsx/package.rb b/lib/axlsx/package.rb index 25656d04..91df81df 100644 --- a/lib/axlsx/package.rb +++ b/lib/axlsx/package.rb @@ -54,10 +54,21 @@ module Axlsx # # You will find a file called test.xlsx def serialize(output, confirm_valid=false) return false unless !confirm_valid || self.validate.empty? - f = File.new(output, "w") - Zip::ZipOutputStream.open(f.path) do |zip| - parts.each{ |part| zip.put_next_entry(part[:entry]); zip.puts(part[:doc]) } + p = parts + Zip::ZipOutputStream.open(output) do |zip| + p.each do |part| + zip.put_next_entry(part[:entry]); zip.puts(part[:doc]) unless part[:doc].nil? + end end + Zip::ZipFile.open(output) do |zip| + p.each do |part| + if part[:path] + zip.add(part[:entry], part[:path], &proc{ true }) + end + end + end + + true end @@ -78,7 +89,7 @@ module Axlsx # p.validate.each { |error| puts error.message } def validate errors = [] - parts.each { |part| errors.concat validate_single_doc(part[:schema], part[:doc]) } + parts.each { |part| errors.concat validate_single_doc(part[:schema], part[:doc]) unless part[:schema].nil? } errors end @@ -105,7 +116,11 @@ module Axlsx workbook.charts.each do |chart| @parts << {:entry => "xl/#{chart.pn}", :doc => chart.to_xml, :schema => DRAWING_XSD} end - + + workbook.images.each do |image| + @parts << {:entry => "xl/#{image.pn}", :path => image.image_src} + end + workbook.worksheets.each do |sheet| @parts << {:entry => "xl/#{sheet.rels_pn}", :doc => sheet.relationships.to_xml, :schema => RELS_XSD} @parts << {:entry => "xl/#{sheet.pn}", :doc => sheet.to_xml, :schema => SML_XSD} @@ -147,6 +162,17 @@ module Axlsx c_types << Axlsx::Override.new(:PartName => "/xl/#{sheet.pn}", :ContentType => WORKSHEET_CT) end + exts = workbook.images.map { |image| image.extname } + exts.uniq.each do |ext| + ct = if ['jpeg', 'jpg'].include?(ext) + JPEG_CT + elsif ext == 'gif' + GIF_CT + elsif ext == 'png' + PNG_CT + end + c_types << Axlsx::Default.new(:ContentType => ct, :Extension => ext ) + end c_types end diff --git a/lib/axlsx/rels/relationship.rb b/lib/axlsx/rels/relationship.rb index 57b9afc0..a76c0c25 100644 --- a/lib/axlsx/rels/relationship.rb +++ b/lib/axlsx/rels/relationship.rb @@ -29,8 +29,7 @@ module Axlsx def Target=(v) Axlsx::validate_string v; @Target = v end def Type=(v) Axlsx::validate_relationship_type v; @Type = v end - # Serializes the relationship - # TODO: use object.rId to get this infomation + # Serializes the relationship # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to. # @param [String] rId the reference id of the object. # @return [String] diff --git a/lib/axlsx/util/constants.rb b/lib/axlsx/util/constants.rb index cb7d7607..50dd6f27 100644 --- a/lib/axlsx/util/constants.rb +++ b/lib/axlsx/util/constants.rb @@ -70,6 +70,9 @@ module Axlsx # chart rels namespace CHART_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/chart" + # image rels namespace + IMAGE_R = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/image" + # table content type TABLE_CT = "application/vnd.openxmlformats-officedocument.spreadsheetml.table+xml" @@ -100,12 +103,30 @@ module Axlsx # chart content type CHART_CT = "application/vnd.openxmlformats-officedocument.drawingml.chart+xml" + # jpeg content type + JPEG_CT = "image/jpeg" + + # gif content type + GIF_CT = "image/gif" + + # png content type + PNG_CT = "image/png" + #drawing content type DRAWING_CT = "application/vnd.openxmlformats-officedocument.drawing+xml" # xml content type extensions XML_EX = "xml" + # jpeg extension + JPEG_EX = "jpeg" + + # gif extension + GIF_EX = "gif" + + # png extension + PNG_EX = "png" + # rels content type extension RELS_EX = "rels" @@ -145,6 +166,9 @@ module Axlsx # chart part CHART_PN = "charts/chart%d.xml" + # chart part + IMAGE_PN = "media/image%d.%s" + # App validation schema APP_XSD = "lib/schema/shared-documentPropertiesExtended.xsd" diff --git a/lib/axlsx/util/validators.rb b/lib/axlsx/util/validators.rb index 01a1850a..827030c7 100644 --- a/lib/axlsx/util/validators.rb +++ b/lib/axlsx/util/validators.rb @@ -112,14 +112,14 @@ module Axlsx # 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 # @param [Any] v The value validated def self.validate_content_type(v) - RestrictionValidator.validate :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], v + RestrictionValidator.validate :content_type, [TABLE_CT, WORKBOOK_CT, APP_CT, RELS_CT, STYLES_CT, XML_CT, WORKSHEET_CT, SHARED_STRINGS_CT, CORE_CT, CHART_CT, JPEG_CT, GIF_CT, PNG_CT, DRAWING_CT], v end # 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 # @param [Any] v The value validated def self.validate_relationship_type(v) - RestrictionValidator.validate :relationship_type, [XML_NS_R, TABLE_R, WORKBOOK_R, WORKSHEET_R, APP_R, RELS_R, CORE_R, STYLES_R, CHART_R, DRAWING_R], v + RestrictionValidator.validate :relationship_type, [XML_NS_R, TABLE_R, WORKBOOK_R, WORKSHEET_R, APP_R, RELS_R, CORE_R, STYLES_R, CHART_R, DRAWING_R, IMAGE_R], v end # Requires that the value is a valid table element type diff --git a/lib/axlsx/version.rb b/lib/axlsx/version.rb index 0f3e00b6..ed7a1ff1 100644 --- a/lib/axlsx/version.rb +++ b/lib/axlsx/version.rb @@ -1,4 +1,4 @@ module Axlsx # version - VERSION="1.0.7" + VERSION="1.0.8" end diff --git a/lib/axlsx/workbook/workbook.rb b/lib/axlsx/workbook/workbook.rb index 00da5247..76a3803c 100644 --- a/lib/axlsx/workbook/workbook.rb +++ b/lib/axlsx/workbook/workbook.rb @@ -44,6 +44,13 @@ require 'axlsx/workbook/worksheet/worksheet.rb' # @return [SimpleTypedList] attr_reader :charts + # A colllection of images associated with this workbook + # @note The recommended way to manage images is Worksheet#add_image + # @see Worksheet#add_image + # @see Pic + # @return [SimpleTypedList] + attr_reader :images + # A colllection of drawings associated with this workbook # @note The recommended way to manage drawings is Worksheet#add_chart # @see Worksheet#add_chart @@ -77,6 +84,7 @@ require 'axlsx/workbook/worksheet/worksheet.rb' @worksheets = SimpleTypedList.new Worksheet @drawings = SimpleTypedList.new Drawing @charts = SimpleTypedList.new Chart + @images = SimpleTypedList.new Pic self.date1904= options[:date1904] unless options[:date1904].nil? yield self if block_given? end diff --git a/lib/axlsx/workbook/worksheet/worksheet.rb b/lib/axlsx/workbook/worksheet/worksheet.rb index c82dbde9..861bb8ef 100644 --- a/lib/axlsx/workbook/worksheet/worksheet.rb +++ b/lib/axlsx/workbook/worksheet/worksheet.rb @@ -119,6 +119,15 @@ module Axlsx chart end + # Adds a media item to the worksheets drawing + # @param [Class] media_type + # @option options [] unknown + def add_image(options={}) + image = drawing.add_image(options) + yield image if block_given? + image + end + # Serializes the worksheet document # @return [String] def to_xml @@ -188,7 +197,7 @@ module Axlsx # @return [Float] # @param [Hash] A hash of auto_fit_data def auto_width(col) - mdw = 6.0 # maximum digit with is always 6.0 in testable fonts so instead of beating RMagick every time, I am hardcoding it here. + mdw = 6.0 # maximum digit with is always 6.0 with RMagick's default font mdw_count = 0 best_guess = 1.5 #direct testing shows the results of the documented formula to be a bit too small. This is a best guess scaling font_scale = col[:sz].to_f / (self.workbook.styles.fonts[0].sz.to_f || 11.0) diff --git a/test/drawing/tc_drawing.rb b/test/drawing/tc_drawing.rb index 474f5b51..7dd21c32 100644 --- a/test/drawing/tc_drawing.rb +++ b/test/drawing/tc_drawing.rb @@ -18,13 +18,22 @@ class TestDrawing < Test::Unit::TestCase chart = @ws.add_chart(Axlsx::Pie3DChart, :title=>"bob", :start_at=>[0,0], :end_at=>[1,1]) assert(chart.is_a?(Axlsx::Pie3DChart), "must create a chart") assert_equal(@ws.workbook.charts.last, chart, "must be added to workbook charts collection") - assert_equal(@ws.drawing.anchors.last.graphic_frame.chart, chart, "an anchor has been created and holds a reference to this chart") + assert_equal(@ws.drawing.anchors.last.object.chart, chart, "an anchor has been created and holds a reference to this chart") anchor = @ws.drawing.anchors.last assert_equal([anchor.from.row, anchor.from.col], [0,0], "options for start at are applied") assert_equal([anchor.to.row, anchor.to.col], [1,1], "options for start at are applied") assert_equal(chart.title.text, "bob", "option for title is applied") end + def test_add_image + src = File.dirname(__FILE__) + "/../../examples/image1.jpeg" + image = @ws.add_image(:image_src => src, :start_at=>[0,0], :width=>600, :height=>400) + assert(@ws.drawing.anchors.last.is_a?(Axlsx::OneCellAnchor)) + assert(image.is_a?(Axlsx::Pic)) + assert_equal(600, image.width) + assert_equal(400, image.height) + end + def test_charts assert(@ws.drawing.charts.empty?) chart = @ws.add_chart(Axlsx::Pie3DChart, :title=>"bob", :start_at=>[0,0], :end_at=>[1,1]) diff --git a/test/drawing/tc_one_cell_anchor.rb b/test/drawing/tc_one_cell_anchor.rb new file mode 100644 index 00000000..d2618622 --- /dev/null +++ b/test/drawing/tc_one_cell_anchor.rb @@ -0,0 +1,67 @@ +require 'test/unit' +require 'axlsx.rb' + +class TestOneCellAnchor < Test::Unit::TestCase + + def setup + @p = Axlsx::Package.new + @ws = @p.workbook.add_worksheet + @test_img = File.dirname(__FILE__) + "/../../examples/image1.jpeg" + @image = @ws.add_image :image_src => @test_img + @anchor = @image.anchor + end + + def teardown + end + + def test_initialization + assert(@anchor.from.col == 0) + assert(@anchor.from.row == 0) + assert(@anchor.width == 0) + assert(@anchor.height == 0) + end + + def test_from + assert(@anchor.from.is_a?(Axlsx::Marker)) + end + + def test_object + assert(@anchor.object.is_a?(Axlsx::Pic)) + end + + def test_index + assert(@anchor.index, @anchor.drawing.anchors.index(@anchor)) + end + + def test_width + assert_raise(ArgumentError) { @anchor.width = "a" } + assert_nothing_raised { @anchor.width = 600 } + assert_equal(@anchor.width, 600) + end + + def test_height + assert_raise(ArgumentError) { @anchor.height = "a" } + assert_nothing_raised { @anchor.height = 400 } + assert_equal(400, @anchor.height) + end + + def test_ext + ext = @anchor.send(:ext) + assert_equal(ext[:cx], (@anchor.width * 914400 / 96)) + assert_equal(ext[:cy], (@anchor.height * 914400 / 96)) + end + + def test_options + assert_raise(ArgumentError, 'invalid start_at') { @ws.add_image :image_src=>@test_img, :start_at=>[1] } + i = @ws.add_image :image_src=>@test_img, :start_at => [1,2], :width=>100, :height=>200, :name=>"someimage", :descr=>"a neat image" + + assert_equal("a neat image", i.descr) + assert_equal("someimage", i.name) + assert_equal(200, i.height) + assert_equal(100, i.width) + assert_equal(1, i.anchor.from.col) + assert_equal(2, i.anchor.from.row) + assert_equal(@test_img, i.image_src) + end + +end diff --git a/test/drawing/tc_pic.rb b/test/drawing/tc_pic.rb new file mode 100644 index 00000000..2d6c603d --- /dev/null +++ b/test/drawing/tc_pic.rb @@ -0,0 +1,71 @@ +require 'test/unit' +require 'axlsx.rb' + +class TestPic < Test::Unit::TestCase + + def setup + @p = Axlsx::Package.new + ws = @p.workbook.add_worksheet + @test_img = File.dirname(__FILE__) + "/../../examples/image1.jpeg" + @image = ws.add_image :image_src => @test_img + end + + def teardown + end + + def test_initialization + assert_equal(@p.workbook.images.first, @image) + assert_equal(@image.image_src, @test_img) + end + + def test_name + assert_raise(ArgumentError) { @image.name = 49 } + assert_nothing_raised { @image.name = "unknown" } + assert_equal(@image.name, "unknown") + end + + def test_start_at + assert_raise(ArgumentError) { @image.start_at "a", 1 } + assert_nothing_raised { @image.start_at 6, 7 } + assert_equal(@image.anchor.from.col, 6) + assert_equal(@image.anchor.from.row, 7) + end + + def test_width + assert_raise(ArgumentError) { @image.width = "a" } + assert_nothing_raised { @image.width = 600 } + assert_equal(@image.width, 600) + end + + def test_height + assert_raise(ArgumentError) { @image.height = "a" } + assert_nothing_raised { @image.height = 600 } + assert_equal(600, @image.height) + end + + def test_image_src + assert_raise(ArgumentError) { @image.image_src = 49 } + assert_raise(ArgumentError) { @image.image_src = 'Unknown' } + assert_raise(ArgumentError) { @image.image_src = __FILE__ } + assert_nothing_raised { @image.image_src = @test_img } + assert_equal(@image.image_src, @test_img) + end + + def test_descr + assert_raise(ArgumentError) { @image.descr = 49 } + assert_nothing_raised { @image.descr = "test" } + assert_equal(@image.descr, "test") + end + + def test_to_xml + schema = Nokogiri::XML::Schema(File.open(Axlsx::DRAWING_XSD)) + doc = Nokogiri::XML(@image.anchor.drawing.to_xml) + errors = [] + schema.validate(doc).each do |error| + errors.push error + puts error.message + end + assert(errors.empty?, "error free validation") + end + +end diff --git a/test/tc_package.rb b/test/tc_package.rb index 1cba34c1..ad511161 100644 --- a/test/tc_package.rb +++ b/test/tc_package.rb @@ -16,8 +16,6 @@ class TestPackage < Test::Unit::TestCase assert(Axlsx::Package.new.workbook.worksheets.size == 0, 'Workbook should not have sheets by default') end - # TODO this test needs better file access validation! - # as does serialization! def test_serialization fname = 'axlsx_test_serialization.xlsx' assert_nothing_raised do |
