diff options
| author | Randy Morgan <[email protected]> | 2011-11-20 23:44:58 +0900 |
|---|---|---|
| committer | Randy Morgan <[email protected]> | 2011-11-20 23:44:58 +0900 |
| commit | 2d0ac967e94c5944ccccf9adad8da5a9d082df29 (patch) | |
| tree | 194839f4ce3687bd51577bab7e75dddc21ad5c9c | |
| parent | 9d210b319c43141120c42aa740fd4a8670e5029a (diff) | |
| download | caxlsx-2d0ac967e94c5944ccccf9adad8da5a9d082df29.tar.gz caxlsx-2d0ac967e94c5944ccccf9adad8da5a9d082df29.zip | |
pushing docs
67 files changed, 50893 insertions, 1 deletions
diff --git a/.yardoc/objects/root.dat b/.yardoc/objects/root.dat Binary files differindex 98988407..72bd306a 100644 --- a/.yardoc/objects/root.dat +++ b/.yardoc/objects/root.dat diff --git a/axlsx-1.0.1.a.gem b/axlsx-1.0.1.a.gem Binary files differnew file mode 100644 index 00000000..81402856 --- /dev/null +++ b/axlsx-1.0.1.a.gem diff --git a/axlsx.gemspec b/axlsx.gemspec index 84681a16..3eeaf9ca 100644 --- a/axlsx.gemspec +++ b/axlsx.gemspec @@ -17,5 +17,4 @@ EOF s.add_runtime_dependency 'active_support', '~> 3' s.add_runtime_dependency 'rmagick', '~> 2.12' s.add_runtime_dependency 'rubyzip', '~> 0.9.4' - end diff --git a/doc/Axlsx.html b/doc/Axlsx.html new file mode 100644 index 00000000..287a5c12 --- /dev/null +++ b/doc/Axlsx.html @@ -0,0 +1,2443 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<title> + Module: Axlsx + + — 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 (A)</a> » + + + <span class="title">Axlsx</span> + + + <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div> +</div> + + <div id="search"> + + <a id="class_list_link" href="#">Class List</a> + + <a id="method_list_link" href="#">Method List</a> + + <a id="file_list_link" href="#">File List</a> + +</div> + <div class="clear"></div> + </div> + + <iframe id="search_frame"></iframe> + + <div id="content"><h1>Module: Axlsx + + + +</h1> + +<dl class="box"> + + + + + + + + + <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/drawing/axis.rb,<br /> lib/axlsx/drawing/chart.rb,<br /> lib/axlsx/stylesheet/xf.rb,<br /> lib/axlsx/doc_props/app.rb,<br /> lib/axlsx/drawing/title.rb,<br /> lib/axlsx/util/constants.rb,<br /> lib/axlsx/doc_props/core.rb,<br /> lib/axlsx/drawing/marker.rb,<br /> lib/axlsx/drawing/series.rb,<br /> lib/axlsx/drawing/view_3D.rb,<br /> lib/axlsx/util/validators.rb,<br /> lib/axlsx/stylesheet/font.rb,<br /> lib/axlsx/stylesheet/fill.rb,<br /> lib/axlsx/drawing/scaling.rb,<br /> lib/axlsx/drawing/drawing.rb,<br /> lib/axlsx/drawing/cat_axis.rb,<br /> lib/axlsx/stylesheet/color.rb,<br /> lib/axlsx/drawing/val_axis.rb,<br /> lib/axlsx/stylesheet/styles.rb,<br /> lib/axlsx/workbook/workbook.rb,<br /> lib/axlsx/rels/relationship.rb,<br /> lib/axlsx/stylesheet/border.rb,<br /> lib/axlsx/rels/relationships.rb,<br /> lib/axlsx/drawing/bar_series.rb,<br /> lib/axlsx/drawing/pie_series.rb,<br /> lib/axlsx/stylesheet/num_fmt.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/pie_3D_chart.rb,<br /> lib/axlsx/content_type/override.rb,<br /> lib/axlsx/stylesheet/cell_style.rb,<br /> lib/axlsx/drawing/graphic_frame.rb,<br /> lib/axlsx/util/simple_typed_list.rb,<br /> lib/axlsx/workbook/worksheet/row.rb,<br /> lib/axlsx/stylesheet/table_style.rb,<br /> lib/axlsx/stylesheet/pattern_fill.rb,<br /> lib/axlsx/stylesheet/table_styles.rb,<br /> lib/axlsx/workbook/worksheet/cell.rb,<br /> lib/axlsx/drawing/two_cell_anchor.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> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +Create Office Open XML Spreadsheets (xlsx) with safe and full control over +cell styles, automatically resized column widths and 3D pie charts. +</p> + + + </div> +</div> +<div class="tags"> + + +</div><h2>Defined Under Namespace</h2> +<p class="children"> + + + + + <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/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/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/Series.html" title="Axlsx::Series (class)">Series</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/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> + + <h2>Constant Summary</h2> + + <dl class="constants"> + + <dt id="VERSION-constant" class="">VERSION = + <div class="docstring"> + <div class="discussion"> + <p> +version +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"1.0.1.a"</span> +</pre></dd> + + <dt id="ENCODING-constant" class="">ENCODING = + <div class="docstring"> + <div class="discussion"> + <p> +XML Encoding +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"UTF-8"</span> +</pre></dd> + + <dt id="XML_NS-constant" class="">XML_NS = + <div class="docstring"> + <div class="discussion"> + <p> +spreadsheetML namespace +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/spreadsheetml/2006/main"</span> +</pre></dd> + + <dt id="XML_NS_T-constant" class="">XML_NS_T = + <div class="docstring"> + <div class="discussion"> + <p> +content-types namespace +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/package/2006/content-types"</span> +</pre></dd> + + <dt id="APP_NS-constant" class="">APP_NS = + <div class="docstring"> + <div class="discussion"> + <p> +extended-properties namespace +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/officeDocument/2006/extended-properties"</span> +</pre></dd> + + <dt id="APP_NS_VT-constant" class="">APP_NS_VT = + <div class="docstring"> + <div class="discussion"> + <p> +doc props namespace +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes"</span> +</pre></dd> + + <dt id="CORE_NS-constant" class="">CORE_NS = + <div class="docstring"> + <div class="discussion"> + <p> +core properties namespace +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/package/2006/metadata/core-properties"</span> +</pre></dd> + + <dt id="CORE_NS_DC-constant" class="">CORE_NS_DC = + <div class="docstring"> + <div class="discussion"> + <p> +dc elements (core) namespace +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"http://purl.org/dc/elements/1.1/"</span> +</pre></dd> + + <dt id="CORE_NS_DCMIT-constant" class="">CORE_NS_DCMIT = + <div class="docstring"> + <div class="discussion"> + <p> +dcmit (core) namespcace +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"http://purl.org/dc/dcmitype/"</span> +</pre></dd> + + <dt id="CORE_NS_DCT-constant" class="">CORE_NS_DCT = + <div class="docstring"> + <div class="discussion"> + <p> +dc terms namespace +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"http://purl.org/dc/terms/"</span> +</pre></dd> + + <dt id="CORE_NS_XSI-constant" class="">CORE_NS_XSI = + <div class="docstring"> + <div class="discussion"> + <p> +xml schema namespace +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"http://www.w3.org/2001/XMLSchema-instance"</span> +</pre></dd> + + <dt id="XML_NS_XDR-constant" class="">XML_NS_XDR = + <div class="docstring"> + <div class="discussion"> + <p> +spreadsheet drawing namespace +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/drawingml/2006/spreadsheetDrawing"</span> +</pre></dd> + + <dt id="XML_NS_A-constant" class="">XML_NS_A = + <div class="docstring"> + <div class="discussion"> + <p> +drawing namespace +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/drawingml/2006/main"</span> +</pre></dd> + + <dt id="XML_NS_C-constant" class="">XML_NS_C = + <div class="docstring"> + <div class="discussion"> + <p> +chart namespace +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/drawingml/2006/chart"</span> +</pre></dd> + + <dt id="XML_NS_R-constant" class="">XML_NS_R = + <div class="docstring"> + <div class="discussion"> + <p> +relationships namespace +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/officeDocument/2006/relationships"</span> +</pre></dd> + + <dt id="RELS_R-constant" class="">RELS_R = + <div class="docstring"> + <div class="discussion"> + <p> +relationships name space +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/package/2006/relationships"</span> +</pre></dd> + + <dt id="TABLE_R-constant" class="">TABLE_R = + <div class="docstring"> + <div class="discussion"> + <p> +table rels namespace +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/officeDocument/2006/relationships/table"</span> +</pre></dd> + + <dt id="WORKBOOK_R-constant" class="">WORKBOOK_R = + <div class="docstring"> + <div class="discussion"> + <p> +workbook rels namespace +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument"</span> +</pre></dd> + + <dt id="WORKSHEET_R-constant" class="">WORKSHEET_R = + <div class="docstring"> + <div class="discussion"> + <p> +worksheet rels namespace +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet"</span> +</pre></dd> + + <dt id="APP_R-constant" class="">APP_R = + <div class="docstring"> + <div class="discussion"> + <p> +app rels namespace +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties"</span> +</pre></dd> + + <dt id="CORE_R-constant" class="">CORE_R = + <div class="docstring"> + <div class="discussion"> + <p> +core rels namespace +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/officeDocument/2006/relationships/metadata/core-properties"</span> +</pre></dd> + + <dt id="STYLES_R-constant" class="">STYLES_R = + <div class="docstring"> + <div class="discussion"> + <p> +styles rels namespace +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles"</span> +</pre></dd> + + <dt id="DRAWING_R-constant" class="">DRAWING_R = + <div class="docstring"> + <div class="discussion"> + <p> +drawing rels namespace +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/officeDocument/2006/relationships/drawing"</span> +</pre></dd> + + <dt id="CHART_R-constant" class="">CHART_R = + <div class="docstring"> + <div class="discussion"> + <p> +chart rels namespace +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"http://schemas.openxmlformats.org/officeDocument/2006/relationships/chart"</span> +</pre></dd> + + <dt id="TABLE_CT-constant" class="">TABLE_CT = + <div class="docstring"> + <div class="discussion"> + <p> +table content type +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"application/vnd.openxmlformats-officedocument.spreadsheetml.table+xml"</span> +</pre></dd> + + <dt id="WORKBOOK_CT-constant" class="">WORKBOOK_CT = + <div class="docstring"> + <div class="discussion"> + <p> +workbook content type +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet.main+xml"</span> +</pre></dd> + + <dt id="APP_CT-constant" class="">APP_CT = + <div class="docstring"> + <div class="discussion"> + <p> +app content type +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"application/vnd.openxmlformats-officedocument.extended-properties+xml"</span> +</pre></dd> + + <dt id="RELS_CT-constant" class="">RELS_CT = + <div class="docstring"> + <div class="discussion"> + <p> +rels content type +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"application/vnd.openxmlformats-package.relationships+xml"</span> +</pre></dd> + + <dt id="STYLES_CT-constant" class="">STYLES_CT = + <div class="docstring"> + <div class="discussion"> + <p> +styles content type +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"application/vnd.openxmlformats-officedocument.spreadsheetml.styles+xml"</span> +</pre></dd> + + <dt id="XML_CT-constant" class="">XML_CT = + <div class="docstring"> + <div class="discussion"> + <p> +xml content type +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"application/xml"</span> +</pre></dd> + + <dt id="WORKSHEET_CT-constant" class="">WORKSHEET_CT = + <div class="docstring"> + <div class="discussion"> + <p> +worksheet content type +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml"</span> +</pre></dd> + + <dt id="SHARED_STRINGS_CT-constant" class="">SHARED_STRINGS_CT = + <div class="docstring"> + <div class="discussion"> + <p> +shared strings content type +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"application/vnd.openxmlformats-officedocument.spreadsheetml.sharedStrings+xml"</span> +</pre></dd> + + <dt id="CORE_CT-constant" class="">CORE_CT = + <div class="docstring"> + <div class="discussion"> + <p> +core content type +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"application/vnd.openxmlformats-package.core-properties+xml"</span> +</pre></dd> + + <dt id="CHART_CT-constant" class="">CHART_CT = + <div class="docstring"> + <div class="discussion"> + <p> +chart content type +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"application/vnd.openxmlformats-officedocument.drawingml.chart+xml"</span> +</pre></dd> + + <dt id="DRAWING_CT-constant" class="">DRAWING_CT = + <div class="docstring"> + <div class="discussion"> + <p> +drawing content type +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"application/vnd.openxmlformats-officedocument.drawing+xml"</span> +</pre></dd> + + <dt id="XML_EX-constant" class="">XML_EX = + <div class="docstring"> + <div class="discussion"> + <p> +xml content type extensions +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"xml"</span> +</pre></dd> + + <dt id="RELS_EX-constant" class="">RELS_EX = + <div class="docstring"> + <div class="discussion"> + <p> +rels content type extension +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"rels"</span> +</pre></dd> + + <dt id="WORKBOOK_PN-constant" class="">WORKBOOK_PN = + <div class="docstring"> + <div class="discussion"> + <p> +workbook part +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"xl/workbook.xml"</span> +</pre></dd> + + <dt id="STYLES_PN-constant" class="">STYLES_PN = + <div class="docstring"> + <div class="discussion"> + <p> +styles part +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"styles.xml"</span> +</pre></dd> + + <dt id="APP_PN-constant" class="">APP_PN = + <div class="docstring"> + <div class="discussion"> + <p> +app part +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"docProps/app.xml"</span> +</pre></dd> + + <dt id="CORE_PN-constant" class="">CORE_PN = + <div class="docstring"> + <div class="discussion"> + <p> +core part +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"docProps/core.xml"</span> +</pre></dd> + + <dt id="CONTENT_TYPES_PN-constant" class="">CONTENT_TYPES_PN = + <div class="docstring"> + <div class="discussion"> + <p> +content types part +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"[Content_Types].xml"</span> +</pre></dd> + + <dt id="RELS_PN-constant" class="">RELS_PN = + <div class="docstring"> + <div class="discussion"> + <p> +rels part +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"_rels/.rels"</span> +</pre></dd> + + <dt id="WORKBOOK_RELS_PN-constant" class="">WORKBOOK_RELS_PN = + <div class="docstring"> + <div class="discussion"> + <p> +workbook rels part +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"xl/_rels/workbook.xml.rels"</span> +</pre></dd> + + <dt id="WORKSHEET_PN-constant" class="">WORKSHEET_PN = + <div class="docstring"> + <div class="discussion"> + <p> +worksheet part +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"worksheets/sheet%d.xml"</span> +</pre></dd> + + <dt id="WORKSHEET_RELS_PN-constant" class="">WORKSHEET_RELS_PN = + <div class="docstring"> + <div class="discussion"> + <p> +worksheet rels part +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"worksheets/_rels/sheet%d.xml.rels"</span> +</pre></dd> + + <dt id="DRAWING_PN-constant" class="">DRAWING_PN = + <div class="docstring"> + <div class="discussion"> + <p> +drawing part +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"drawings/drawing%d.xml"</span> +</pre></dd> + + <dt id="DRAWING_RELS_PN-constant" class="">DRAWING_RELS_PN = + <div class="docstring"> + <div class="discussion"> + <p> +drawing rels part +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"drawings/_rels/drawing%d.xml.rels"</span> +</pre></dd> + + <dt id="CHART_PN-constant" class="">CHART_PN = + <div class="docstring"> + <div class="discussion"> + <p> +chart part +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"charts/chart%d.xml"</span> +</pre></dd> + + <dt id="APP_XSD-constant" class="">APP_XSD = + <div class="docstring"> + <div class="discussion"> + <p> +App validation schema +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"lib/schema/shared-documentPropertiesExtended.xsd"</span> +</pre></dd> + + <dt id="CORE_XSD-constant" class="">CORE_XSD = + <div class="docstring"> + <div class="discussion"> + <p> +core validation schema +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"lib/schema/opc-coreProperties.xsd"</span> +</pre></dd> + + <dt id="CONTENT_TYPES_XSD-constant" class="">CONTENT_TYPES_XSD = + <div class="docstring"> + <div class="discussion"> + <p> +content types validation schema +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"lib/schema/opc-contentTypes.xsd"</span> +</pre></dd> + + <dt id="RELS_XSD-constant" class="">RELS_XSD = + <div class="docstring"> + <div class="discussion"> + <p> +rels validation schema +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"lib/schema/opc-relationships.xsd"</span> +</pre></dd> + + <dt id="SML_XSD-constant" class="">SML_XSD = + <div class="docstring"> + <div class="discussion"> + <p> +spreadsheetML validation schema +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"lib/schema/sml.xsd"</span> +</pre></dd> + + <dt id="DRAWING_XSD-constant" class="">DRAWING_XSD = + <div class="docstring"> + <div class="discussion"> + <p> +drawing validation schema +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"lib/schema/dml-spreadsheetDrawing.xsd"</span> +</pre></dd> + + <dt id="NUM_FMT_PERCENT-constant" class="">NUM_FMT_PERCENT = + <div class="docstring"> + <div class="discussion"> + <p> +number format id for pecentage formatting using the default formatting id. +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='integer val'>9</span> +</pre></dd> + + <dt id="NUM_FMT_YYYYMMDD-constant" class="">NUM_FMT_YYYYMMDD = + <div class="docstring"> + <div class="discussion"> + <p> +number format id for date format like 2011/11/13 +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='integer val'>100</span> +</pre></dd> + + <dt id="NUM_FMT_YYYYMMDDHHMMSS-constant" class="">NUM_FMT_YYYYMMDDHHMMSS = + <div class="docstring"> + <div class="discussion"> + <p> +number format id for time format the creates 2011/11/13 12:23:10 +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='integer val'>101</span> +</pre></dd> + + <dt id="STYLE_THIN_BORDER-constant" class="">STYLE_THIN_BORDER = + <div class="docstring"> + <div class="discussion"> + <p> +cellXfs id for thin borders around the cell +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='integer val'>1</span> +</pre></dd> + + <dt id="ERR_RESTRICTION-constant" class="">ERR_RESTRICTION = + <div class="docstring"> + <div class="discussion"> + <p> +error messages RestrictionValidor +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"Invalid Data: %s. %s must be one of %s."</span> +</pre></dd> + + <dt id="ERR_TYPE-constant" class="">ERR_TYPE = + <div class="docstring"> + <div class="discussion"> + <p> +error message DataTypeValidator +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"Invalid Data %s for %s. must be %s."</span> +</pre></dd> + + <dt id="ERR_REGEX-constant" class="">ERR_REGEX = + <div class="docstring"> + <div class="discussion"> + <p> +error message for RegexValidator +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='string val'>"Invalid Data. %s does not match %s."</span> +</pre></dd> + + </dl> + + + + + + + + <h2> + Class Method Summary + <small>(<a href="#" class="summary_toggle">collapse</a>)</small> + </h2> + + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> + + <a href="#cell_range-class_method" title="cell_range (class method)">+ (Object) <strong>cell_range</strong>(items) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +determines the cell range for the items provided. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#validate_boolean-class_method" title="validate_boolean (class method)">+ (Object) <strong>validate_boolean</strong>(v) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Requires that the value is a form that can be evaluated as a boolean in an +xml document. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#validate_content_type-class_method" title="validate_content_type (class method)">+ (Object) <strong>validate_content_type</strong>(v) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Requires that the value is a valid content_type TABLE_CT, WORKBOOK_CT, +APP_CT, RELS_CT, STYLES_CT, XML_CT, WORKSHEET_CT, SHARED_STRINGS_CT, +CORE_CT, CHART_CT, DRAWING_CT are allowed. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#validate_float-class_method" title="validate_float (class method)">+ (Object) <strong>validate_float</strong>(v) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Requires that the value is a Float. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#validate_gradient_type-class_method" title="validate_gradient_type (class method)">+ (Object) <strong>validate_gradient_type</strong>(v) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Requires that the value is a gradient_type. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#validate_horizontal_alignment-class_method" title="validate_horizontal_alignment (class method)">+ (Object) <strong>validate_horizontal_alignment</strong>(v) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Requires that the value is a valid horizontal_alignment :general, :left, +:center, :right, :fill, :justify, :centerContinuous, :distributed are +allowed. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#validate_int-class_method" title="validate_int (class method)">+ (Object) <strong>validate_int</strong>(v) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Requires that the value is a Fixnum or Integer. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#validate_pattern_type-class_method" title="validate_pattern_type (class method)">+ (Object) <strong>validate_pattern_type</strong>(v) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Requires that the value is valid pattern type. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#validate_relationship_type-class_method" title="validate_relationship_type (class method)">+ (Object) <strong>validate_relationship_type</strong>(v) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Requires that the value is a valid relationship_type XML_NS_R, TABLE_R, +WORKBOOK_R, WORKSHEET_R, APP_R, RELS_R, CORE_R, STYLES_R, CHART_R, +DRAWING_R are allowed. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#validate_string-class_method" title="validate_string (class method)">+ (Object) <strong>validate_string</strong>(v) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Requires that the value is a String. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#validate_table_element_type-class_method" title="validate_table_element_type (class method)">+ (Object) <strong>validate_table_element_type</strong>(v) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Requires that the value is a valid table element type :wholeTable, +:headerRow, :totalRow, :firstColumn, :lastColumn, :firstRowStripe, +:secondRowStripe, :firstColumnStripe, :secondColumnStripe, +:firstHeaderCell, :lastHeaderCell, :firstTotalCell, :lastTotalCell, +:firstSubtotalColumn, :secondSubtotalColumn, :thirdSubtotalColumn, +:firstSubtotalRow, :secondSubtotalRow, :thirdSubtotalRow, :blankRow, +:firstColumnSubheading, :secondColumnSubheading, :thirdColumnSubheading, +:firstRowSubheading, :secondRowSubheading, :thirdRowSubheading, +:pageFieldLabels, :pageFieldValues are allowed. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#validate_unsigned_int-class_method" title="validate_unsigned_int (class method)">+ (Boolean) <strong>validate_unsigned_int</strong>(v) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Requires that the value is a Fixnum or Integer and is greater or equal to +0. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#validate_vertical_alignment-class_method" title="validate_vertical_alignment (class method)">+ (Object) <strong>validate_vertical_alignment</strong>(v) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Requires that the value is a valid vertical_alignment :top, :center, +:bottom, :justify, :distributed are allowed. +</p> +</div></span> + +</li> + + + </ul> + + + + + <div id="class_method_details" class="method_details_list"> + <h2>Class Method Details</h2> + + + <div class="method_details first"> + <p class="signature first" id="cell_range-class_method"> + + + (<tt>Object</tt>) <strong>cell_range</strong>(items) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +determines the cell range for the items provided +</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +31 +32 +33 +34 +35</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx.rb', line 31</span> + +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='cell_range identifier id'>cell_range</span><span class='lparen token'>(</span><span class='items identifier id'>items</span><span class='rparen token'>)</span> + <span class='return return kw'>return</span> <span class='string val'>""</span> <span class='unless unless_mod kw'>unless</span> <span class='items identifier id'>items</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span> <span class='Cell constant id'>Cell</span> + <span class='dstring node'>"#{items.first.row.worksheet.name}!"</span> <span class='plus op'>+</span> + <span class='dstring node'>"#{items.first.r_abs}:#{items.last.r_abs}"</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="validate_boolean-class_method"> + + + (<tt>Object</tt>) <strong>validate_boolean</strong>(v) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Requires that the value is a form that can be evaluated as a boolean in an +xml document. The value must be an instance of Fixnum, String, Integer, +Symbol, TrueClass or FalseClass and it must be one of 0, 1, +"true", "false", :true, :false, true, false, +"0", or "1" +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>v</span> + + + <span class='type'>(<tt>Any</tt>)</span> + + + + — + <div class='inline'><p> +The value validated +</p> +</div> + + </li> + +</ul> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +65 +66 +67</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 65</span> + +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate_boolean identifier id'>validate_boolean</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='DataTypeValidator constant id'>DataTypeValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='lparen token'>(</span><span class='symbol val'>:boolean</span><span class='comma token'>,</span> <span class='lbrack token'>[</span><span class='Fixnum constant id'>Fixnum</span><span class='comma token'>,</span> <span class='String constant id'>String</span><span class='comma token'>,</span> <span class='Integer constant id'>Integer</span><span class='comma token'>,</span> <span class='Symbol constant id'>Symbol</span><span class='comma token'>,</span> <span class='TrueClass constant id'>TrueClass</span><span class='comma token'>,</span> <span class='FalseClass constant id'>FalseClass</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='comma token'>,</span> <span class='lambda identifier id'>lambda</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='v identifier id'>v</span><span class='bitor op'>|</span> <span class='lbrack token'>[</span><span class='integer val'>0</span><span class='comma token'>,</span> <span class='integer val'>1</span><span class='comma token'>,</span> <span class='string val'>"true"</span><span class='comma token'>,</span> <span class='string val'>"false"</span><span class='comma token'>,</span> <span class='symbol val'>:true</span><span class='comma token'>,</span> <span class='symbol val'>:false</span><span class='comma token'>,</span> <span class='true true kw'>true</span><span class='comma token'>,</span> <span class='false false kw'>false</span><span class='comma token'>,</span> <span class='string val'>"0"</span><span class='comma token'>,</span> <span class='string val'>"1"</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='include? fid id'>include?</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="validate_content_type-class_method"> + + + (<tt>Object</tt>) <strong>validate_content_type</strong>(v) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Requires that the value is a valid content_type TABLE_CT, WORKBOOK_CT, +APP_CT, RELS_CT, STYLES_CT, XML_CT, WORKSHEET_CT, SHARED_STRINGS_CT, +CORE_CT, CHART_CT, DRAWING_CT are allowed +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>v</span> + + + <span class='type'>(<tt>Any</tt>)</span> + + + + — + <div class='inline'><p> +The value validated +</p> +</div> + + </li> + +</ul> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +114 +115 +116</pre> + </td> + <td> + <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='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="validate_float-class_method"> + + + (<tt>Object</tt>) <strong>validate_float</strong>(v) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Requires that the value is a Float +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>v</span> + + + <span class='type'>(<tt>Any</tt>)</span> + + + + — + <div class='inline'><p> +The value validated +</p> +</div> + + </li> + +</ul> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +77 +78 +79</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 77</span> + +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate_float identifier id'>validate_float</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='DataTypeValidator constant id'>DataTypeValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='symbol val'>:float</span><span class='comma token'>,</span> <span class='Float constant id'>Float</span><span class='comma token'>,</span> <span class='v identifier id'>v</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="validate_gradient_type-class_method"> + + + (<tt>Object</tt>) <strong>validate_gradient_type</strong>(v) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Requires that the value is a gradient_type. valid types are :linear and +:path +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>v</span> + + + <span class='type'>(<tt>Any</tt>)</span> + + + + — + <div class='inline'><p> +The value validated +</p> +</div> + + </li> + +</ul> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +93 +94 +95</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 93</span> + +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate_gradient_type identifier id'>validate_gradient_type</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='RestrictionValidator constant id'>RestrictionValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='symbol val'>:gradient_type</span><span class='comma token'>,</span> <span class='lbrack token'>[</span><span class='symbol val'>:linear</span><span class='comma token'>,</span> <span class='symbol val'>:path</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='v identifier id'>v</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="validate_horizontal_alignment-class_method"> + + + (<tt>Object</tt>) <strong>validate_horizontal_alignment</strong>(v) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Requires that the value is a valid horizontal_alignment :general, :left, +:center, :right, :fill, :justify, :centerContinuous, :distributed are +allowed +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>v</span> + + + <span class='type'>(<tt>Any</tt>)</span> + + + + — + <div class='inline'><p> +The value validated +</p> +</div> + + </li> + +</ul> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +100 +101 +102</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 100</span> + +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate_horizontal_alignment identifier id'>validate_horizontal_alignment</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='RestrictionValidator constant id'>RestrictionValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='symbol val'>:horizontal_alignment</span><span class='comma token'>,</span> <span class='lbrack token'>[</span><span class='symbol val'>:general</span><span class='comma token'>,</span> <span class='symbol val'>:left</span><span class='comma token'>,</span> <span class='symbol val'>:center</span><span class='comma token'>,</span> <span class='symbol val'>:right</span><span class='comma token'>,</span> <span class='symbol val'>:fill</span><span class='comma token'>,</span> <span class='symbol val'>:justify</span><span class='comma token'>,</span> <span class='symbol val'>:centerContinuous</span><span class='comma token'>,</span> <span class='symbol val'>:distributed</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='v identifier id'>v</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="validate_int-class_method"> + + + (<tt>Object</tt>) <strong>validate_int</strong>(v) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Requires that the value is a Fixnum or Integer +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>v</span> + + + <span class='type'>(<tt>Any</tt>)</span> + + + + — + <div class='inline'><p> +The value validated +</p> +</div> + + </li> + +</ul> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +57 +58 +59</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 57</span> + +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate_int identifier id'>validate_int</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='DataTypeValidator constant id'>DataTypeValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='symbol val'>:unsigned_int</span><span class='comma token'>,</span> <span class='lbrack token'>[</span><span class='Fixnum constant id'>Fixnum</span><span class='comma token'>,</span> <span class='Integer constant id'>Integer</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='v identifier id'>v</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="validate_pattern_type-class_method"> + + + (<tt>Object</tt>) <strong>validate_pattern_type</strong>(v) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Requires that the value is valid pattern type. valid pattern types must be +one of :none, :solid, :mediumGray, :darkGray, :lightGray, :darkHorizontal, +:darkVertical, :darkDown, :darkUp, :darkGrid, :darkTrellis, +:lightHorizontal, :lightVertical, :lightDown, :lightUp, :lightGrid, +:lightTrellis, :gray125, or :gray0625. +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>v</span> + + + <span class='type'>(<tt>Any</tt>)</span> + + + + — + <div class='inline'><p> +The value validated +</p> +</div> + + </li> + +</ul> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +85 +86 +87 +88</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 85</span> + +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate_pattern_type identifier id'>validate_pattern_type</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='RestrictionValidator constant id'>RestrictionValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='symbol val'>:pattern_type</span><span class='comma token'>,</span> <span class='lbrack token'>[</span><span class='symbol val'>:none</span><span class='comma token'>,</span> <span class='symbol val'>:solid</span><span class='comma token'>,</span> <span class='symbol val'>:mediumGray</span><span class='comma token'>,</span> <span class='symbol val'>:darkGray</span><span class='comma token'>,</span> <span class='symbol val'>:lightGray</span><span class='comma token'>,</span> <span class='symbol val'>:darkHorizontal</span><span class='comma token'>,</span> <span class='symbol val'>:darkVertical</span><span class='comma token'>,</span> <span class='symbol val'>:darkDown</span><span class='comma token'>,</span> <span class='symbol val'>:darkUp</span><span class='comma token'>,</span> <span class='symbol val'>:darkGrid</span><span class='comma token'>,</span> + <span class='symbol val'>:darkTrellis</span><span class='comma token'>,</span> <span class='symbol val'>:lightHorizontal</span><span class='comma token'>,</span> <span class='symbol val'>:lightVertical</span><span class='comma token'>,</span> <span class='symbol val'>:lightDown</span><span class='comma token'>,</span> <span class='symbol val'>:lightUp</span><span class='comma token'>,</span> <span class='symbol val'>:lightGrid</span><span class='comma token'>,</span> <span class='symbol val'>:lightTrellis</span><span class='comma token'>,</span> <span class='symbol val'>:gray125</span><span class='comma token'>,</span> <span class='symbol val'>:gray0625</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='v identifier id'>v</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="validate_relationship_type-class_method"> + + + (<tt>Object</tt>) <strong>validate_relationship_type</strong>(v) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Requires that the value is a valid relationship_type XML_NS_R, TABLE_R, +WORKBOOK_R, WORKSHEET_R, APP_R, RELS_R, CORE_R, STYLES_R, CHART_R, +DRAWING_R are allowed +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>v</span> + + + <span class='type'>(<tt>Any</tt>)</span> + + + + — + <div class='inline'><p> +The value validated +</p> +</div> + + </li> + +</ul> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +121 +122 +123</pre> + </td> + <td> + <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='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="validate_string-class_method"> + + + (<tt>Object</tt>) <strong>validate_string</strong>(v) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Requires that the value is a String +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>v</span> + + + <span class='type'>(<tt>Any</tt>)</span> + + + + — + <div class='inline'><p> +The value validated +</p> +</div> + + </li> + +</ul> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +71 +72 +73</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 71</span> + +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate_string identifier id'>validate_string</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='DataTypeValidator constant id'>DataTypeValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='symbol val'>:string</span><span class='comma token'>,</span> <span class='String constant id'>String</span><span class='comma token'>,</span> <span class='v identifier id'>v</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="validate_table_element_type-class_method"> + + + (<tt>Object</tt>) <strong>validate_table_element_type</strong>(v) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Requires that the value is a valid table element type :wholeTable, +:headerRow, :totalRow, :firstColumn, :lastColumn, :firstRowStripe, +:secondRowStripe, :firstColumnStripe, :secondColumnStripe, +:firstHeaderCell, :lastHeaderCell, :firstTotalCell, :lastTotalCell, +:firstSubtotalColumn, :secondSubtotalColumn, :thirdSubtotalColumn, +:firstSubtotalRow, :secondSubtotalRow, :thirdSubtotalRow, :blankRow, +:firstColumnSubheading, :secondColumnSubheading, :thirdColumnSubheading, +:firstRowSubheading, :secondRowSubheading, :thirdRowSubheading, +:pageFieldLabels, :pageFieldValues are allowed +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>v</span> + + + <span class='type'>(<tt>Any</tt>)</span> + + + + — + <div class='inline'><p> +The value validated +</p> +</div> + + </li> + +</ul> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +128 +129 +130</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 128</span> + +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate_table_element_type identifier id'>validate_table_element_type</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='RestrictionValidator constant id'>RestrictionValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='symbol val'>:table_element_type</span><span class='comma token'>,</span> <span class='lbrack token'>[</span><span class='symbol val'>:wholeTable</span><span class='comma token'>,</span> <span class='symbol val'>:headerRow</span><span class='comma token'>,</span> <span class='symbol val'>:totalRow</span><span class='comma token'>,</span> <span class='symbol val'>:firstColumn</span><span class='comma token'>,</span> <span class='symbol val'>:lastColumn</span><span class='comma token'>,</span> <span class='symbol val'>:firstRowStripe</span><span class='comma token'>,</span> <span class='symbol val'>:secondRowStripe</span><span class='comma token'>,</span> <span class='symbol val'>:firstColumnStripe</span><span class='comma token'>,</span> <span class='symbol val'>:secondColumnStripe</span><span class='comma token'>,</span> <span class='symbol val'>:firstHeaderCell</span><span class='comma token'>,</span> <span class='symbol val'>:lastHeaderCell</span><span class='comma token'>,</span> <span class='symbol val'>:firstTotalCell</span><span class='comma token'>,</span> <span class='symbol val'>:lastTotalCell</span><span class='comma token'>,</span> <span class='symbol val'>:firstSubtotalColumn</span><span class='comma token'>,</span> <span class='symbol val'>:secondSubtotalColumn</span><span class='comma token'>,</span> <span class='symbol val'>:thirdSubtotalColumn</span><span class='comma token'>,</span> <span class='symbol val'>:firstSubtotalRow</span><span class='comma token'>,</span> <span class='symbol val'>:secondSubtotalRow</span><span class='comma token'>,</span> <span class='symbol val'>:thirdSubtotalRow</span><span class='comma token'>,</span> <span class='symbol val'>:blankRow</span><span class='comma token'>,</span> <span class='symbol val'>:firstColumnSubheading</span><span class='comma token'>,</span> <span class='symbol val'>:secondColumnSubheading</span><span class='comma token'>,</span> <span class='symbol val'>:thirdColumnSubheading</span><span class='comma token'>,</span> <span class='symbol val'>:firstRowSubheading</span><span class='comma token'>,</span> <span class='symbol val'>:secondRowSubheading</span><span class='comma token'>,</span> <span class='symbol val'>:thirdRowSubheading</span><span class='comma token'>,</span> <span class='symbol val'>:pageFieldLabels</span><span class='comma token'>,</span> <span class='symbol val'>:pageFieldValues</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='v identifier id'>v</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="validate_unsigned_int-class_method"> + + + (<tt>Boolean</tt>) <strong>validate_unsigned_int</strong>(v) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Requires that the value is a Fixnum or Integer and is greater or equal to 0 +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>v</span> + + + <span class='type'>(<tt>Any</tt>)</span> + + + + — + <div class='inline'><p> +The value validated +</p> +</div> + + </li> + +</ul> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + — + <div class='inline'><p> +true if the data is valid +</p> +</div> + + </li> + +</ul> +<h3>Raises:</h3> +<ul class="raise"> + + <li> + + + <span class='type'>(<tt>ArgumentError</tt>)</span> + + + + — + <div class='inline'><p> +raised if the value is not a Fixnum or Integer value greater or equal to 0 +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +51 +52 +53</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 51</span> + +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate_unsigned_int identifier id'>validate_unsigned_int</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='DataTypeValidator constant id'>DataTypeValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='lparen token'>(</span><span class='symbol val'>:unsigned_int</span><span class='comma token'>,</span> <span class='lbrack token'>[</span><span class='Fixnum constant id'>Fixnum</span><span class='comma token'>,</span> <span class='Integer constant id'>Integer</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='comma token'>,</span> <span class='lambda identifier id'>lambda</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='v identifier id'>v</span><span class='bitor op'>|</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span><span class='lparen token'>(</span><span class='symbol val'>:>=</span><span class='rparen token'>)</span> <span class='andop op'>&&</span> <span class='v identifier id'>v</span> <span class='geq op'>>=</span> <span class='integer val'>0</span> <span class='rbrace token'>}</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="validate_vertical_alignment-class_method"> + + + (<tt>Object</tt>) <strong>validate_vertical_alignment</strong>(v) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Requires that the value is a valid vertical_alignment :top, :center, +:bottom, :justify, :distributed are allowed +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>v</span> + + + <span class='type'>(<tt>Any</tt>)</span> + + + + — + <div class='inline'><p> +The value validated +</p> +</div> + + </li> + +</ul> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +107 +108 +109</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 107</span> + +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate_vertical_alignment identifier id'>validate_vertical_alignment</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='RestrictionValidator constant id'>RestrictionValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='symbol val'>:vertical_alignment</span><span class='comma token'>,</span> <span class='lbrack token'>[</span><span class='symbol val'>:top</span><span class='comma token'>,</span> <span class='symbol val'>:center</span><span class='comma token'>,</span> <span class='symbol val'>:bottom</span><span class='comma token'>,</span> <span class='symbol val'>:justify</span><span class='comma token'>,</span> <span class='symbol val'>:distributed</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='v identifier id'>v</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43: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/App.html b/doc/Axlsx/App.html new file mode 100644 index 00000000..c4f9169c --- /dev/null +++ b/doc/Axlsx/App.html @@ -0,0 +1,2640 @@ +<!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::App + + — 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 (A)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">App</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::App + + + +</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::App</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/doc_props/app.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> +Support is not implemented for the following complex types: +</p> +<p> +HeadingPairs (VectorVariant), TitlesOfParts (VectorLpstr), HLinks +(VectorVariant), DigSig (DigSigBlob) +</p> +</div> + </div> + +<p> +App represents the app.xml document. The attributes for this object are +primarily managed by the application the end user uses to edit the +document. None of the attributes are required to serialize a valid xlsx +object. +</p> + + + </div> +</div> +<div class="tags"> + + + <h3>See Also:</h3> + <ul class="see"> + + <li>shared-documentPropertiesExtendedshared-documentPropertiesExtended.xsd</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="#Application-instance_method" title="#Application (instance method)">- (String) <strong>Application</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The name of the application. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#AppVersion-instance_method" title="#AppVersion (instance method)">- (String) <strong>AppVersion</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The version of the application. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#Characters-instance_method" title="#Characters (instance method)">- (Integer) <strong>Characters</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The number of characters in the document. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#CharactersWithSpaces-instance_method" title="#CharactersWithSpaces (instance method)">- (Integer) <strong>CharactersWithSpaces</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The number of characters in the document including spaces. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#Company-instance_method" title="#Company (instance method)">- (String) <strong>Company</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The name of the company generating the document. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#DocSecurity-instance_method" title="#DocSecurity (instance method)">- (Integer) <strong>DocSecurity</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Document security. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#HiddenSlides-instance_method" title="#HiddenSlides (instance method)">- (Integer) <strong>HiddenSlides</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The number of hidden slides. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#HyperLinkBase-instance_method" title="#HyperLinkBase (instance method)">- (String) <strong>HyperLinkBase</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The base for hyper links in the document. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#HyperlinksChanged-instance_method" title="#HyperlinksChanged (instance method)">- (Boolean) <strong>HyperlinksChanged</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Indicates that the hyper links in the document have been changed. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#Lines-instance_method" title="#Lines (instance method)">- (Integer) <strong>Lines</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The number of lines in the document. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#LinksUpToDate-instance_method" title="#LinksUpToDate (instance method)">- (Boolean) <strong>LinksUpToDate</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The links in the document are up to date. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#Manager-instance_method" title="#Manager (instance method)">- (String) <strong>Manager</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The name of the manager for the document. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#MMClips-instance_method" title="#MMClips (instance method)">- (Integer) <strong>MMClips</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The total number multimedia clips. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#Notes-instance_method" title="#Notes (instance method)">- (Integer) <strong>Notes</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The number of slides that have notes. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#Pages-instance_method" title="#Pages (instance method)">- (Integer) <strong>Pages</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The number of pages in the document. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#Paragraphs-instance_method" title="#Paragraphs (instance method)">- (Integer) <strong>Paragraphs</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The number of paragraphs in the document. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#PresentationFormat-instance_method" title="#PresentationFormat (instance method)">- (String) <strong>PresentationFormat</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The intended format of the presentation. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#ScaleCrop-instance_method" title="#ScaleCrop (instance method)">- (Boolean) <strong>ScaleCrop</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The display mode for the document thumbnail. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#ShareDoc-instance_method" title="#ShareDoc (instance method)">- (Boolean) <strong>ShareDoc</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Indicates if the document is shared. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#Slides-instance_method" title="#Slides (instance method)">- (Intger) <strong>Slides</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The number of slides in the document. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#Template-instance_method" title="#Template (instance method)">- (String) <strong>Template</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The name of the document template. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#TotalTime-instance_method" title="#TotalTime (instance method)">- (Integer) <strong>TotalTime</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The total amount of time spent editing. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#Words-instance_method" title="#Words (instance method)">- (Integer) <strong>Words</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The number of words in the document. +</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="#initalize-instance_method" title="#initalize (instance method)">- (Object) <strong>initalize</strong>(options = {}) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates an App object. +</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> </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Generate an app.xml document. +</p> +</div></span> + +</li> + + + </ul> + + + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="Application=-instance_method"></span> + <span id="Application-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="Application-instance_method"> + + - (<tt>String</tt>) <strong>Application</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The name of the application +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +The name of the application +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +74 +75 +76</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 74</span> + +<span class='def def kw'>def</span> <span class='Application constant id'>Application</span> + <span class='@Application ivar id'>@Application</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="AppVersion=-instance_method"></span> + <span id="AppVersion-instance_method"></span> + <div class="method_details "> + <p class="signature " id="AppVersion-instance_method"> + + - (<tt>String</tt>) <strong>AppVersion</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The version of the application. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +The version of the application. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +77 +78 +79</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 77</span> + +<span class='def def kw'>def</span> <span class='AppVersion constant id'>AppVersion</span> + <span class='@AppVersion ivar id'>@AppVersion</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="Characters=-instance_method"></span> + <span id="Characters-instance_method"></span> + <div class="method_details "> + <p class="signature " id="Characters-instance_method"> + + - (<tt>Integer</tt>) <strong>Characters</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The number of characters in the document. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +The number of characters in the document. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +29 +30 +31</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 29</span> + +<span class='def def kw'>def</span> <span class='Characters constant id'>Characters</span> + <span class='@Characters ivar id'>@Characters</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="CharactersWithSpaces=-instance_method"></span> + <span id="CharactersWithSpaces-instance_method"></span> + <div class="method_details "> + <p class="signature " id="CharactersWithSpaces-instance_method"> + + - (<tt>Integer</tt>) <strong>CharactersWithSpaces</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The number of characters in the document including spaces. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +The number of characters in the document including spaces. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +62 +63 +64</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 62</span> + +<span class='def def kw'>def</span> <span class='CharactersWithSpaces constant id'>CharactersWithSpaces</span> + <span class='@CharactersWithSpaces ivar id'>@CharactersWithSpaces</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="Company=-instance_method"></span> + <span id="Company-instance_method"></span> + <div class="method_details "> + <p class="signature " id="Company-instance_method"> + + - (<tt>String</tt>) <strong>Company</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The name of the company generating the document. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +The name of the company generating the document. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +20 +21 +22</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 20</span> + +<span class='def def kw'>def</span> <span class='Company constant id'>Company</span> + <span class='@Company ivar id'>@Company</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="DocSecurity=-instance_method"></span> + <span id="DocSecurity-instance_method"></span> + <div class="method_details "> + <p class="signature " id="DocSecurity-instance_method"> + + - (<tt>Integer</tt>) <strong>DocSecurity</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Document security +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +Document security +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +80 +81 +82</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 80</span> + +<span class='def def kw'>def</span> <span class='DocSecurity constant id'>DocSecurity</span> + <span class='@DocSecurity ivar id'>@DocSecurity</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="HiddenSlides=-instance_method"></span> + <span id="HiddenSlides-instance_method"></span> + <div class="method_details "> + <p class="signature " id="HiddenSlides-instance_method"> + + - (<tt>Integer</tt>) <strong>HiddenSlides</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The number of hidden slides. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +The number of hidden slides. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +50 +51 +52</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 50</span> + +<span class='def def kw'>def</span> <span class='HiddenSlides constant id'>HiddenSlides</span> + <span class='@HiddenSlides ivar id'>@HiddenSlides</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="HyperLinkBase=-instance_method"></span> + <span id="HyperLinkBase-instance_method"></span> + <div class="method_details "> + <p class="signature " id="HyperLinkBase-instance_method"> + + - (<tt>String</tt>) <strong>HyperLinkBase</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The base for hyper links in the document. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +The base for hyper links in the document. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +68 +69 +70</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 68</span> + +<span class='def def kw'>def</span> <span class='HyperLinkBase constant id'>HyperLinkBase</span> + <span class='@HyperLinkBase ivar id'>@HyperLinkBase</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="HyperlinksChanged=-instance_method"></span> + <span id="HyperlinksChanged-instance_method"></span> + <div class="method_details "> + <p class="signature " id="HyperlinksChanged-instance_method"> + + - (<tt>Boolean</tt>) <strong>HyperlinksChanged</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Indicates that the hyper links in the document have been changed. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + — + <div class='inline'><p> +Indicates that the hyper links in the document have been changed. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +71 +72 +73</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 71</span> + +<span class='def def kw'>def</span> <span class='HyperlinksChanged constant id'>HyperlinksChanged</span> + <span class='@HyperlinksChanged ivar id'>@HyperlinksChanged</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="Lines=-instance_method"></span> + <span id="Lines-instance_method"></span> + <div class="method_details "> + <p class="signature " id="Lines-instance_method"> + + - (<tt>Integer</tt>) <strong>Lines</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The number of lines in the document. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +The number of lines in the document. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +35 +36 +37</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 35</span> + +<span class='def def kw'>def</span> <span class='Lines constant id'>Lines</span> + <span class='@Lines ivar id'>@Lines</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="LinksUpToDate=-instance_method"></span> + <span id="LinksUpToDate-instance_method"></span> + <div class="method_details "> + <p class="signature " id="LinksUpToDate-instance_method"> + + - (<tt>Boolean</tt>) <strong>LinksUpToDate</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The links in the document are up to date. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + — + <div class='inline'><p> +The links in the document are up to date. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +59 +60 +61</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 59</span> + +<span class='def def kw'>def</span> <span class='LinksUpToDate constant id'>LinksUpToDate</span> + <span class='@LinksUpToDate ivar id'>@LinksUpToDate</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="Manager=-instance_method"></span> + <span id="Manager-instance_method"></span> + <div class="method_details "> + <p class="signature " id="Manager-instance_method"> + + - (<tt>String</tt>) <strong>Manager</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The name of the manager for the document. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +The name of the manager for the document. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +17 +18 +19</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 17</span> + +<span class='def def kw'>def</span> <span class='Manager constant id'>Manager</span> + <span class='@Manager ivar id'>@Manager</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="MMClips=-instance_method"></span> + <span id="MMClips-instance_method"></span> + <div class="method_details "> + <p class="signature " id="MMClips-instance_method"> + + - (<tt>Integer</tt>) <strong>MMClips</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The total number multimedia clips +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +The total number multimedia clips +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +53 +54 +55</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 53</span> + +<span class='def def kw'>def</span> <span class='MMClips constant id'>MMClips</span> + <span class='@MMClips ivar id'>@MMClips</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="Notes=-instance_method"></span> + <span id="Notes-instance_method"></span> + <div class="method_details "> + <p class="signature " id="Notes-instance_method"> + + - (<tt>Integer</tt>) <strong>Notes</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The number of slides that have notes. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +The number of slides that have notes. +</p> +</div> + + </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/doc_props/app.rb', line 44</span> + +<span class='def def kw'>def</span> <span class='Notes constant id'>Notes</span> + <span class='@Notes ivar id'>@Notes</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="Pages=-instance_method"></span> + <span id="Pages-instance_method"></span> + <div class="method_details "> + <p class="signature " id="Pages-instance_method"> + + - (<tt>Integer</tt>) <strong>Pages</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The number of pages in the document. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +The number of pages in the document. +</p> +</div> + + </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/doc_props/app.rb', line 23</span> + +<span class='def def kw'>def</span> <span class='Pages constant id'>Pages</span> + <span class='@Pages ivar id'>@Pages</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="Paragraphs=-instance_method"></span> + <span id="Paragraphs-instance_method"></span> + <div class="method_details "> + <p class="signature " id="Paragraphs-instance_method"> + + - (<tt>Integer</tt>) <strong>Paragraphs</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The number of paragraphs in the document +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +The number of paragraphs in the document +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +38 +39 +40</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 38</span> + +<span class='def def kw'>def</span> <span class='Paragraphs constant id'>Paragraphs</span> + <span class='@Paragraphs ivar id'>@Paragraphs</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="PresentationFormat=-instance_method"></span> + <span id="PresentationFormat-instance_method"></span> + <div class="method_details "> + <p class="signature " id="PresentationFormat-instance_method"> + + - (<tt>String</tt>) <strong>PresentationFormat</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The intended format of the presentation. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +The intended format of the presentation. +</p> +</div> + + </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/doc_props/app.rb', line 32</span> + +<span class='def def kw'>def</span> <span class='PresentationFormat constant id'>PresentationFormat</span> + <span class='@PresentationFormat ivar id'>@PresentationFormat</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="ScaleCrop=-instance_method"></span> + <span id="ScaleCrop-instance_method"></span> + <div class="method_details "> + <p class="signature " id="ScaleCrop-instance_method"> + + - (<tt>Boolean</tt>) <strong>ScaleCrop</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The display mode for the document thumbnail. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + — + <div class='inline'><p> +The display mode for the document thumbnail. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +56 +57 +58</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 56</span> + +<span class='def def kw'>def</span> <span class='ScaleCrop constant id'>ScaleCrop</span> + <span class='@ScaleCrop ivar id'>@ScaleCrop</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="ShareDoc=-instance_method"></span> + <span id="ShareDoc-instance_method"></span> + <div class="method_details "> + <p class="signature " id="ShareDoc-instance_method"> + + - (<tt>Boolean</tt>) <strong>ShareDoc</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Indicates if the document is shared. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + — + <div class='inline'><p> +Indicates if the document is shared. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +65 +66 +67</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 65</span> + +<span class='def def kw'>def</span> <span class='ShareDoc constant id'>ShareDoc</span> + <span class='@ShareDoc ivar id'>@ShareDoc</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="Slides=-instance_method"></span> + <span id="Slides-instance_method"></span> + <div class="method_details "> + <p class="signature " id="Slides-instance_method"> + + - (<tt>Intger</tt>) <strong>Slides</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The number of slides in the document. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Intger</tt>)</span> + + + + — + <div class='inline'><p> +The number of slides in the document. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +41 +42 +43</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 41</span> + +<span class='def def kw'>def</span> <span class='Slides constant id'>Slides</span> + <span class='@Slides ivar id'>@Slides</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="Template=-instance_method"></span> + <span id="Template-instance_method"></span> + <div class="method_details "> + <p class="signature " id="Template-instance_method"> + + - (<tt>String</tt>) <strong>Template</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The name of the document template. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +The name of the document template. +</p> +</div> + + </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/doc_props/app.rb', line 14</span> + +<span class='def def kw'>def</span> <span class='Template constant id'>Template</span> + <span class='@Template ivar id'>@Template</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="TotalTime=-instance_method"></span> + <span id="TotalTime-instance_method"></span> + <div class="method_details "> + <p class="signature " id="TotalTime-instance_method"> + + - (<tt>Integer</tt>) <strong>TotalTime</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The total amount of time spent editing. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +The total amount of time spent editing. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +47 +48 +49</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 47</span> + +<span class='def def kw'>def</span> <span class='TotalTime constant id'>TotalTime</span> + <span class='@TotalTime ivar id'>@TotalTime</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="Words=-instance_method"></span> + <span id="Words-instance_method"></span> + <div class="method_details "> + <p class="signature " id="Words-instance_method"> + + - (<tt>Integer</tt>) <strong>Words</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The number of words in the document. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +The number of words in the document. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +26 +27 +28</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 26</span> + +<span class='def def kw'>def</span> <span class='Words constant id'>Words</span> + <span class='@Words ivar id'>@Words</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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="initalize-instance_method"> + + - (<tt>Object</tt>) <strong>initalize</strong>(options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates an App object +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <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">Template</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">Manager</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">Pages</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">Words</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">Characters</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">PresentationFormat</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">Lines</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">Paragraphs</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">Slides</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">Notes</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">TotalTime</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">HiddenSlides</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">MMClips</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">ScaleCrop</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">LinksUpToDate</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">CharactersWithSpaces</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">ShareDoc</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">HyperLinkBase</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">HyperlinksChanged</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">Application</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">AppVersion</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">DocSecurity</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +105 +106 +107 +108 +109</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 105</span> + +<span class='def def kw'>def</span> <span class='initalize identifier id'>initalize</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="to_xml-instance_method"> + + - (<tt>String</tt>) <strong>to_xml</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Generate an app.xml document +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +The document as a string +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +137 +138 +139 +140 +141 +142 +143 +144 +145 +146</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 137</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='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='symbol val'>:Properties</span><span class='comma token'>,</span> <span class='symbol val'>:xmlns</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='APP_NS constant id'>APP_NS</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:vt'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='APP_NS_VT constant id'>APP_NS_VT</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='value identifier id'>value</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"ap:#{name}"</span><span class='comma token'>,</span> <span class='value identifier id'>value</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43:55 2011 by + <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> + 0.7.3 (ruby-1.8.7). +</div> + + </body> +</html>
\ No newline at end of file diff --git a/doc/Axlsx/Axis.html b/doc/Axlsx/Axis.html new file mode 100644 index 00000000..ca05fe5f --- /dev/null +++ b/doc/Axlsx/Axis.html @@ -0,0 +1,1047 @@ +<!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::Axis + + — 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 (A)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">Axis</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::Axis + + + +</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::Axis</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/drawing/axis.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +the access class defines common properties and values for chart axis +</p> + + + </div> +</div> +<div class="tags"> + + +</div><div id="subclasses"> + <h2>Direct Known Subclasses</h2> + <p class="children"><span class='object_link'><a href="CatAxis.html" title="Axlsx::CatAxis (class)">CatAxis</a></span>, <span class='object_link'><a href="ValAxis.html" title="Axlsx::ValAxis (class)">ValAxis</a></span></p> +</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="#axId-instance_method" title="#axId (instance method)">- (Integer) <strong>axId</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +the id of the axis. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#axPos-instance_method" title="#axPos (instance method)">- (Symbol) <strong>axPos</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The position of the axis must be one of [:l, :r, :t, :b]. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#crossAx-instance_method" title="#crossAx (instance method)">- (Integer) <strong>crossAx</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The perpendicular axis. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#crosses-instance_method" title="#crosses (instance method)">- (Symbol) <strong>crosses</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +specifies how the perpendicular axis is crossed must be one of [:autoZero, +:min, :max]. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#format_code-instance_method" title="#format_code (instance method)">- (String) <strong>format_code</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The number format format code for this axis. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#scaling-instance_method" title="#scaling (instance method)">- (Scaling) <strong>scaling</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The scaling of the axis. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#tickLblPos-instance_method" title="#tickLblPos (instance method)">- (Symbol) <strong>tickLblPos</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +the position of the tick labels must be one of [:nextTo, :high, :low]. +</p> +</div></span> + +</li> + + + </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)">- (Axis) <strong>initialize</strong>(axId, crossAx, options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates an Axis object. +</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 common axis. +</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::Axis (class)">Axis</a></span></tt>) <strong>initialize</strong>(axId, crossAx, options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates an Axis object +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>axId</span> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +the id of this axis +</p> +</div> + + </li> + + <li> + + <span class='name'>crossAx</span> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +the id of the perpendicular axis +</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">axPos</span> + <span class="type">(<tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">crosses</span> + <span class="type">(<tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">tickLblPos</span> + <span class="type">(<tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.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='axId identifier id'>axId</span><span class='comma token'>,</span> <span class='crossAx identifier id'>crossAx</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='validate_unsigned_int identifier id'>validate_unsigned_int</span><span class='lparen token'>(</span><span class='axId identifier id'>axId</span><span class='rparen token'>)</span> + <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='validate_unsigned_int identifier id'>validate_unsigned_int</span><span class='lparen token'>(</span><span class='crossAx identifier id'>crossAx</span><span class='rparen token'>)</span> + <span class='@axId ivar id'>@axId</span> <span class='assign token'>=</span> <span class='axId identifier id'>axId</span> + <span class='@crossAx ivar id'>@crossAx</span> <span class='assign token'>=</span> <span class='crossAx identifier id'>crossAx</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='axPos identifier id'>axPos</span> <span class='assign token'>=</span> <span class='symbol val'>:l</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='tickLblPos identifier id'>tickLblPos</span> <span class='assign token'>=</span> <span class='symbol val'>:nextTo</span> + <span class='@scaling ivar id'>@scaling</span> <span class='assign token'>=</span> <span class='Scaling constant id'>Scaling</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:orientation=</span><span class='gt op'>></span><span class='symbol val'>:minMax</span><span class='rparen token'>)</span> + <span class='@formatCode ivar id'>@formatCode</span> <span class='assign token'>=</span> <span class='string val'>""</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='crosses identifier id'>crosses</span> <span class='assign token'>=</span> <span class='symbol val'>:autoZero</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id=""></span> + <span id="axId-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="axId-instance_method"> + + - (<tt>Integer</tt>) <strong>axId</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +the id of the axis +</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"> + + +8 +9 +10</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 8</span> + +<span class='def def kw'>def</span> <span class='axId identifier id'>axId</span> + <span class='@axId ivar id'>@axId</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="axPos=-instance_method"></span> + <span id="axPos-instance_method"></span> + <div class="method_details "> + <p class="signature " id="axPos-instance_method"> + + - (<tt>Symbol</tt>) <strong>axPos</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The position of the axis must be one of [:l, :r, :t, :b] +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Symbol</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +21 +22 +23</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 21</span> + +<span class='def def kw'>def</span> <span class='axPos identifier id'>axPos</span> + <span class='@axPos ivar id'>@axPos</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="crossAx-instance_method"></span> + <div class="method_details "> + <p class="signature " id="crossAx-instance_method"> + + - (<tt>Integer</tt>) <strong>crossAx</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The perpendicular axis +</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"> + + +12 +13 +14</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 12</span> + +<span class='def def kw'>def</span> <span class='crossAx identifier id'>crossAx</span> + <span class='@crossAx ivar id'>@crossAx</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="crosses=-instance_method"></span> + <span id="crosses-instance_method"></span> + <div class="method_details "> + <p class="signature " id="crosses-instance_method"> + + - (<tt>Symbol</tt>) <strong>crosses</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +specifies how the perpendicular axis is crossed must be one of [:autoZero, +:min, :max] +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Symbol</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/axis.rb', line 36</span> + +<span class='def def kw'>def</span> <span class='crosses identifier id'>crosses</span> + <span class='@crosses ivar id'>@crosses</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="format_code=-instance_method"></span> + <span id="format_code-instance_method"></span> + <div class="method_details "> + <p class="signature " id="format_code-instance_method"> + + - (<tt>String</tt>) <strong>format_code</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The number format format code for this axis +</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"> + + +31 +32 +33</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 31</span> + +<span class='def def kw'>def</span> <span class='format_code identifier id'>format_code</span> + <span class='@format_code ivar id'>@format_code</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="scaling-instance_method"></span> + <div class="method_details "> + <p class="signature " id="scaling-instance_method"> + + - (<tt><span class='object_link'><a href="Scaling.html" title="Axlsx::Scaling (class)">Scaling</a></span></tt>) <strong>scaling</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The scaling of the axis +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Scaling.html" title="Axlsx::Scaling (class)">Scaling</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +16 +17 +18</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 16</span> + +<span class='def def kw'>def</span> <span class='scaling identifier id'>scaling</span> + <span class='@scaling ivar id'>@scaling</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="tickLblPos=-instance_method"></span> + <span id="tickLblPos-instance_method"></span> + <div class="method_details "> + <p class="signature " id="tickLblPos-instance_method"> + + - (<tt>Symbol</tt>) <strong>tickLblPos</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +the position of the tick labels must be one of [:nextTo, :high, :low] +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Symbol</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +26 +27 +28</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 26</span> + +<span class='def def kw'>def</span> <span class='tickLblPos identifier id'>tickLblPos</span> + <span class='@tickLblPos ivar id'>@tickLblPos</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 common axis +</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"> + + +67 +68 +69 +70 +71 +72 +73 +74 +75 +76</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 67</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:axId'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@axId ivar id'>@axId</span><span class='rparen token'>)</span> + <span class='@scaling ivar id'>@scaling</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:axPos'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@axPos ivar id'>@axPos</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:majorGridlines'</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:numFmt'</span><span class='comma token'>,</span> <span class='symbol val'>:formatCode</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='@format_code ivar id'>@format_code</span><span class='comma token'>,</span> <span class='symbol val'>:sourceLinked=</span><span class='gt op'>></span><span class='string val'>"1"</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:tickLblPos'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@tickLblPos ivar id'>@tickLblPos</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:crossAx'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@crossAx ivar id'>@crossAx</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:crosses'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@crosses ivar id'>@crosses</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:44:00 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/Bar3DChart.html b/doc/Axlsx/Bar3DChart.html new file mode 100644 index 00000000..da7c952c --- /dev/null +++ b/doc/Axlsx/Bar3DChart.html @@ -0,0 +1,1153 @@ +<!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::Bar3DChart + + — 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 (B)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">Bar3DChart</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::Bar3DChart + + + +</h1> + +<dl class="box"> + + <dt class="r1">Inherits:</dt> + <dd class="r1"> + <span class="inheritName"><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></span> + + <ul class="fullTree"> + <li>Object</li> + + <li class="next"><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></li> + + <li class="next">Axlsx::Bar3DChart</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/drawing/bar_3D_chart.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +The Bar3DChart is a three dimentional barchart (who would have guessed?) +that you can add to your worksheet. +</p> + + + </div> +</div> +<div class="tags"> + + <div class="examples"> + <h3>Examples:</h3> + + <h4><div class='inline'><p> +Creating a chart +</p> +</div></h4> + <pre class="example code"><span class='comment val'># This example creates two charts in a single sheet.</span> +<span class='comment val'># The first uses data directly fed to the sheet, while the second references cells withing the worksheet for data.</span> + +<span class='require identifier id'>require</span> <span class='string val'>"rubygems"</span> <span class='comment val'># if that is your preferred way to manage gems!</span> +<span class='require identifier id'>require</span> <span class='string val'>"axlsx"</span> + +<span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> +<span class='ws identifier id'>ws</span> <span class='assign token'>=</span> <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> +<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"This is a chart with no data in the sheet"</span><span class='rbrack token'>]</span> + +<span class='chart identifier id'>chart</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Bar3DChart constant id'>Bar3DChart</span><span class='comma token'>,</span> <span class='symbol val'>:start_at=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:end_at=</span><span class='gt op'>></span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>6</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:title=</span><span class='gt op'>></span><span class='string val'>"Most Popular Pets"</span><span class='rparen token'>)</span> +<span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='add_series identifier id'>add_series</span> <span class='symbol val'>:data</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>9</span><span class='comma token'>,</span> <span class='integer val'>10</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:labels</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Slimy Reptiles"</span><span class='comma token'>,</span> <span class='string val'>"Fuzzy Bunnies"</span><span class='comma token'>,</span> <span class='string val'>"Rottweiler"</span><span class='rbrack token'>]</span> + +<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"This chart uses the data below"</span><span class='rbrack token'>]</span> +<span class='title_row identifier id'>title_row</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Least Popular Pets"</span><span class='rbrack token'>]</span> +<span class='label_row identifier id'>label_row</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>""</span><span class='comma token'>,</span> <span class='string val'>"Dry Skinned Reptiles"</span><span class='comma token'>,</span> <span class='string val'>"Bald Cats"</span><span class='comma token'>,</span> <span class='string val'>"Violent Parrots"</span><span class='rbrack token'>]</span> +<span class='data_row identifier id'>data_row</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Votes"</span><span class='comma token'>,</span> <span class='integer val'>6</span><span class='comma token'>,</span> <span class='integer val'>4</span><span class='comma token'>,</span> <span class='integer val'>1</span><span class='rbrack token'>]</span> + +<span class='chart identifier id'>chart</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Pie3DChart constant id'>Pie3DChart</span><span class='comma token'>,</span> <span class='symbol val'>:start_at</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>11</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:end_at</span> <span class='assign token'>=</span><span class='gt op'>></span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>16</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:title</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='title_row identifier id'>title_row</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='rparen token'>)</span> +<span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='add_series identifier id'>add_series</span> <span class='symbol val'>:data</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='data_row identifier id'>data_row</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='lbrack token'>[</span><span class='lparen token'>(</span><span class='float val'>1</span><span class='dot2 op'>..</span><span class='integer val'>-1</span><span class='rparen token'>)</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:labels</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='label_row identifier id'>label_row</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span> + +<span class='f identifier id'>f</span> <span class='assign token'>=</span> <span class='File constant id'>File</span><span class='dot token'>.</span><span class='open identifier id'>open</span><span class='lparen token'>(</span><span class='string val'>'example_pie_3d_chart.xlsx'</span><span class='comma token'>,</span> <span class='string val'>'w'</span><span class='rparen token'>)</span> +<span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='f identifier id'>f</span><span class='rparen token'>)</span> +</pre> + + </div> + + + <h3>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_row-instance_method" title="Axlsx::Worksheet#add_row (method)">Worksheet#add_row</a></span></li> + + <li><span class='object_link'><a href="Chart.html#add_series-instance_method" title="Axlsx::Chart#add_series (method)">Chart#add_series</a></span></li> + + <li><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></li> + + <li><span class='object_link'><a href="Package.html#serialize-instance_method" title="Axlsx::Package#serialize (method)">Package#serialize</a></span></li> + + </ul> + +</div> + <h2>Constant Summary</h2> + + <dl class="constants"> + + <dt id="GAP_AMOUNT_PERCENT-constant" class="">GAP_AMOUNT_PERCENT = + <div class="docstring"> + <div class="discussion"> + <p> +validation regex for gap amount percent +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='regexp val'>/0*(([0-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)%/</span> +</pre></dd> + + </dl> + + + + + + + + <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="#barDir-instance_method" title="#barDir (instance method)">- (Symbol) <strong>barDir</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The direction of the bars in the chart must be one of [:bar, :col]. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#catAxis-instance_method" title="#catAxis (instance method)">- (CatAxis) <strong>catAxis</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +the category axis. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#gapDepth-instance_method" title="#gapDepth (instance method)">- (String) <strong>gapDepth</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +space between bar or column clusters, as a percentage of the bar or column +width. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#gapWidth-instance_method" title="#gapWidth (instance method)">- (String) <strong>gapWidth</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +space between bar or column clusters, as a percentage of the bar or column +width. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#grouping-instance_method" title="#grouping (instance method)">- (Symbol) <strong>grouping</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +grouping for a column, line, or area chart. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#shape-instance_method" title="#shape (instance method)">- (Symbol) <strong>shape</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The shabe of the bars or columns must be one of [:percentStacked, +:clustered, :standard, :stacked]. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#valAxis-instance_method" title="#valAxis (instance method)">- (ValAxis) <strong>valAxis</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +the category axis. +</p> +</div></span> + +</li> + + + </ul> + + + + + + + + + <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></h3> + <p class="inherited"><span class='object_link'><a href="Chart.html#end_at-instance_method" title="Axlsx::Chart#end_at (method)">end_at</a></span>, <span class='object_link'><a href="Chart.html#graphic_frame-instance_method" title="Axlsx::Chart#graphic_frame (method)">graphic_frame</a></span>, <span class='object_link'><a href="Chart.html#index-instance_method" title="Axlsx::Chart#index (method)">index</a></span>, <span class='object_link'><a href="Chart.html#pn-instance_method" title="Axlsx::Chart#pn (method)">pn</a></span>, <span class='object_link'><a href="Chart.html#series-instance_method" title="Axlsx::Chart#series (method)">series</a></span>, <span class='object_link'><a href="Chart.html#series_type-instance_method" title="Axlsx::Chart#series_type (method)">series_type</a></span>, <span class='object_link'><a href="Chart.html#show_legend-instance_method" title="Axlsx::Chart#show_legend (method)">show_legend</a></span>, <span class='object_link'><a href="Chart.html#start_at-instance_method" title="Axlsx::Chart#start_at (method)">start_at</a></span>, <span class='object_link'><a href="Chart.html#title-instance_method" title="Axlsx::Chart#title (method)">title</a></span>, <span class='object_link'><a href="Chart.html#view3D-instance_method" title="Axlsx::Chart#view3D (method)">view3D</a></span></p> + + + + <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)">- (Bar3DChart) <strong>initialize</strong>(frame, options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new bar chart object. +</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> </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Serializes the bar chart. +</p> +</div></span> + +</li> + + + </ul> + + + + + + + + + + + <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></h3> + <p class="inherited"><span class='object_link'><a href="Chart.html#add_series-instance_method" title="Axlsx::Chart#add_series (method)">#add_series</a></span></p> +<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::Bar3DChart (class)">Bar3DChart</a></span></tt>) <strong>initialize</strong>(frame, options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new bar chart object +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>frame</span> + + + <span class='type'>(<tt><span class='object_link'><a href="GraphicFrame.html" title="Axlsx::GraphicFrame (class)">GraphicFrame</a></span></tt>)</span> + + + + — + <div class='inline'><p> +The workbook that owns this chart. +</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">title</span> + <span class="type">(<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>, <tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">show_legend</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">barDir</span> + <span class="type">(<tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">grouping</span> + <span class="type">(<tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">gapWidth</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">gapDepth</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">shape</span> + <span class="type">(<tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +79 +80 +81 +82 +83 +84 +85 +86 +87 +88 +89</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 79</span> + +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='frame identifier id'>frame</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='frame identifier id'>frame</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='@series_type ivar id'>@series_type</span> <span class='assign token'>=</span> <span class='BarSeries constant id'>BarSeries</span> + <span class='@barDir ivar id'>@barDir</span> <span class='assign token'>=</span> <span class='symbol val'>:bar</span> + <span class='@grouping ivar id'>@grouping</span> <span class='assign token'>=</span> <span class='symbol val'>:clustered</span> + <span class='@catAxId ivar id'>@catAxId</span> <span class='assign token'>=</span> <span class='rand identifier id'>rand</span><span class='lparen token'>(</span><span class='integer val'>8</span> <span class='pow op'>**</span> <span class='integer val'>8</span><span class='rparen token'>)</span> + <span class='@valAxId ivar id'>@valAxId</span> <span class='assign token'>=</span> <span class='rand identifier id'>rand</span><span class='lparen token'>(</span><span class='integer val'>8</span> <span class='pow op'>**</span> <span class='integer val'>8</span><span class='rparen token'>)</span> + <span class='@catAxis ivar id'>@catAxis</span> <span class='assign token'>=</span> <span class='CatAxis constant id'>CatAxis</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='@catAxId ivar id'>@catAxId</span><span class='comma token'>,</span> <span class='@valAxId ivar id'>@valAxId</span><span class='rparen token'>)</span> + <span class='@valAxis ivar id'>@valAxis</span> <span class='assign token'>=</span> <span class='ValAxis constant id'>ValAxis</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='@valAxId ivar id'>@valAxId</span><span class='comma token'>,</span> <span class='@catAxId ivar id'>@catAxId</span><span class='rparen token'>)</span> + <span class='@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='symbol val'>:rAngAx=</span><span class='gt op'>></span><span class='integer val'>1</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="barDir=-instance_method"></span> + <span id="barDir-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="barDir-instance_method"> + + - (<tt>Symbol</tt>) <strong>barDir</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The direction of the bars in the chart must be one of [:bar, :col] +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Symbol</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +47 +48 +49</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 47</span> + +<span class='def def kw'>def</span> <span class='barDir identifier id'>barDir</span> + <span class='@barDir ivar id'>@barDir</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="catAxis-instance_method"></span> + <div class="method_details "> + <p class="signature " id="catAxis-instance_method"> + + - (<tt><span class='object_link'><a href="CatAxis.html" title="Axlsx::CatAxis (class)">CatAxis</a></span></tt>) <strong>catAxis</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +the category axis +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="CatAxis.html" title="Axlsx::CatAxis (class)">CatAxis</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +38 +39 +40</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 38</span> + +<span class='def def kw'>def</span> <span class='catAxis identifier id'>catAxis</span> + <span class='@catAxis ivar id'>@catAxis</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="gapDepth=-instance_method"></span> + <span id="gapDepth-instance_method"></span> + <div class="method_details "> + <p class="signature " id="gapDepth-instance_method"> + + - (<tt>String</tt>) <strong>gapDepth</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +space between bar or column clusters, as a percentage of the bar or column +width. +</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"> + + +51 +52 +53</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 51</span> + +<span class='def def kw'>def</span> <span class='gapDepth identifier id'>gapDepth</span> + <span class='@gapDepth ivar id'>@gapDepth</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="gapWidth=-instance_method"></span> + <span id="gapWidth-instance_method"></span> + <div class="method_details "> + <p class="signature " id="gapWidth-instance_method"> + + - (<tt>String</tt>) <strong>gapWidth</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +space between bar or column clusters, as a percentage of the bar or column +width. +</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"> + + +55 +56 +57</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 55</span> + +<span class='def def kw'>def</span> <span class='gapWidth identifier id'>gapWidth</span> + <span class='@gapWidth ivar id'>@gapWidth</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="grouping=-instance_method"></span> + <span id="grouping-instance_method"></span> + <div class="method_details "> + <p class="signature " id="grouping-instance_method"> + + - (<tt>Symbol</tt>) <strong>grouping</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +grouping for a column, line, or area chart. must be one of +[:percentStacked, :clustered, :standard, :stacked] +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Symbol</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +60 +61 +62</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 60</span> + +<span class='def def kw'>def</span> <span class='grouping identifier id'>grouping</span> + <span class='@grouping ivar id'>@grouping</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="shape=-instance_method"></span> + <span id="shape-instance_method"></span> + <div class="method_details "> + <p class="signature " id="shape-instance_method"> + + - (<tt>Symbol</tt>) <strong>shape</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The shabe of the bars or columns must be one of [:percentStacked, +:clustered, :standard, :stacked] +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Symbol</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +65 +66 +67</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 65</span> + +<span class='def def kw'>def</span> <span class='shape identifier id'>shape</span> + <span class='@shape ivar id'>@shape</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="valAxis-instance_method"></span> + <div class="method_details "> + <p class="signature " id="valAxis-instance_method"> + + - (<tt><span class='object_link'><a href="ValAxis.html" title="Axlsx::ValAxis (class)">ValAxis</a></span></tt>) <strong>valAxis</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +the category axis +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="ValAxis.html" title="Axlsx::ValAxis (class)">ValAxis</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +42 +43 +44</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 42</span> + +<span class='def def kw'>def</span> <span class='valAxis identifier id'>valAxis</span> + <span class='@valAxis ivar id'>@valAxis</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Serializes the bar chart +</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"> + + +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 119</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> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:bar3DChart'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:barDir'</span><span class='comma token'>,</span> <span class='symbol val'>:val</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='barDir identifier id'>barDir</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:grouping'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='grouping identifier id'>grouping</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:varyColors'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='integer val'>1</span><span class='rparen token'>)</span> + <span class='@series ivar id'>@series</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='ser identifier id'>ser</span><span class='bitor op'>|</span> <span class='ser identifier id'>ser</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:gapWidth'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@gapWidth ivar id'>@gapWidth</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@gapWidth ivar id'>@gapWidth</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:gapDepth'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@gapDepth ivar id'>@gapDepth</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@gapDepth ivar id'>@gapDepth</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:shape'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@shape ivar id'>@shape</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@shape ivar id'>@shape</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:axId'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@catAxId ivar id'>@catAxId</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:axId'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@valAxId ivar id'>@valAxId</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:axId'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='@catAxis ivar id'>@catAxis</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='@valAxis ivar id'>@valAxis</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43: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> + + </body> +</html>
\ No newline at end of file diff --git a/doc/Axlsx/BarSeries.html b/doc/Axlsx/BarSeries.html new file mode 100644 index 00000000..d0f196ee --- /dev/null +++ b/doc/Axlsx/BarSeries.html @@ -0,0 +1,762 @@ +<!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::BarSeries + + — 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 (B)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">BarSeries</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::BarSeries + + + +</h1> + +<dl class="box"> + + <dt class="r1">Inherits:</dt> + <dd class="r1"> + <span class="inheritName"><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></span> + + <ul class="fullTree"> + <li>Object</li> + + <li class="next"><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></li> + + <li class="next">Axlsx::BarSeries</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/drawing/bar_series.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 series is to use Chart#add_series +</p> +</div> + </div> + +<p> +A BarSeries defines the title, data and labels for bar charts +</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="Chart.html#add_series-instance_method" title="Axlsx::Chart#add_series (method)">Chart#add_series</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="#data-instance_method" title="#data (instance method)">- (Array, SimpleTypedList) <strong>data</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The data for this series. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#labels-instance_method" title="#labels (instance method)">- (Array, SimpleTypedList) <strong>labels</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The labels for this series. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#shape-instance_method" title="#shape (instance method)">- (Symbol) <strong>shape</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The shabe of the bars or columns must be one of [:percentStacked, +:clustered, :standard, :stacked]. +</p> +</div></span> + +</li> + + + </ul> + + + + + + + + + <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></h3> + <p class="inherited"><span class='object_link'><a href="Series.html#chart-instance_method" title="Axlsx::Series#chart (method)">chart</a></span>, <span class='object_link'><a href="Series.html#index-instance_method" title="Axlsx::Series#index (method)">index</a></span>, <span class='object_link'><a href="Series.html#order-instance_method" title="Axlsx::Series#order (method)">order</a></span>, <span class='object_link'><a href="Series.html#title-instance_method" title="Axlsx::Series#title (method)">title</a></span></p> + + + + <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)">- (BarSeries) <strong>initialize</strong>(chart, options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new series. +</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 series. +</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::BarSeries (class)">BarSeries</a></span></tt>) <strong>initialize</strong>(chart, options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new series +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>chart</span> + + + <span class='type'>(<tt><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</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">data</span> + <span class="type">(<tt>Array</tt>, <tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">labels</span> + <span class="type">(<tt>Array</tt>, <tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">title</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">shape</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +28 +29 +30 +31 +32 +33</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_series.rb', line 28</span> + +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='chart identifier id'>chart</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@shape ivar id'>@shape</span> <span class='assign token'>=</span> <span class='symbol val'>:box</span> + <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='chart identifier id'>chart</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='data identifier id'>data</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:data</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='labels identifier id'>labels</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:labels</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='lbrack token'>[</span><span class='rbrack 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="data=-instance_method"></span> + <span id="data-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="data-instance_method"> + + - (<tt>Array</tt>, <tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>data</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The data for this series. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Array</tt>, <tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +11 +12 +13</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_series.rb', line 11</span> + +<span class='def def kw'>def</span> <span class='data identifier id'>data</span> + <span class='@data ivar id'>@data</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="labels=-instance_method"></span> + <span id="labels-instance_method"></span> + <div class="method_details "> + <p class="signature " id="labels-instance_method"> + + - (<tt>Array</tt>, <tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>labels</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The labels for this series. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Array</tt>, <tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +15 +16 +17</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_series.rb', line 15</span> + +<span class='def def kw'>def</span> <span class='labels identifier id'>labels</span> + <span class='@labels ivar id'>@labels</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="shape=-instance_method"></span> + <span id="shape-instance_method"></span> + <div class="method_details "> + <p class="signature " id="shape-instance_method"> + + - (<tt>Symbol</tt>) <strong>shape</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The shabe of the bars or columns must be one of [:percentStacked, +:clustered, :standard, :stacked] +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Symbol</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +20 +21 +22</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_series.rb', line 20</span> + +<span class='def def kw'>def</span> <span class='shape identifier id'>shape</span> + <span class='@shape ivar id'>@shape</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 series +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>xml</span> + + + <span class='type'>(<tt>Nokogiri::XML::Builder</tt>)</span> + + + + — + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> +</div> + + </li> + +</ul> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74 +75 +76 +77</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_series.rb', line 43</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> + <span class='if if kw'>if</span> <span class='notop op'>!</span><span class='labels identifier id'>labels</span><span class='dot token'>.</span><span class='empty? fid id'>empty?</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:cat'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:strRef'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:f'</span><span class='comma token'>,</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='cell_range identifier id'>cell_range</span><span class='lparen token'>(</span><span class='labels identifier id'>labels</span><span class='rparen token'>)</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:strCache'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:ptCount'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='labels identifier id'>labels</span><span class='dot token'>.</span><span class='size identifier id'>size</span><span class='rparen token'>)</span> + <span class='labels identifier id'>labels</span><span class='dot token'>.</span><span class='each_with_index identifier id'>each_with_index</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='cell identifier id'>cell</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span> + <span class='v identifier id'>v</span> <span class='assign token'>=</span> <span class='cell identifier id'>cell</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Cell constant id'>Cell</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='cell identifier id'>cell</span><span class='dot token'>.</span><span class='value identifier id'>value</span> <span class='colon op'>:</span> <span class='cell identifier id'>cell</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:pt'</span><span class='comma token'>,</span> <span class='symbol val'>:idx=</span><span class='gt op'>></span><span class='index identifier id'>index</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:v'</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:val'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:numRef'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:f'</span><span class='comma token'>,</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='cell_range identifier id'>cell_range</span><span class='lparen token'>(</span><span class='data identifier id'>data</span><span class='rparen token'>)</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:numCache'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:formatCode'</span><span class='comma token'>,</span> <span class='string val'>'General'</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:ptCount'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='data identifier id'>data</span><span class='dot token'>.</span><span class='size identifier id'>size</span><span class='rparen token'>)</span> + <span class='data identifier id'>data</span><span class='dot token'>.</span><span class='each_with_index identifier id'>each_with_index</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='cell identifier id'>cell</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span> + <span class='v identifier id'>v</span> <span class='assign token'>=</span> <span class='cell identifier id'>cell</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Cell constant id'>Cell</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='cell identifier id'>cell</span><span class='dot token'>.</span><span class='value identifier id'>value</span> <span class='colon op'>:</span> <span class='cell identifier id'>cell</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:pt'</span><span class='comma token'>,</span> <span class='symbol val'>:idx=</span><span class='gt op'>></span><span class='index identifier id'>index</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:v'</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43:58 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/Border.html b/doc/Axlsx/Border.html new file mode 100644 index 00000000..413ee9c1 --- /dev/null +++ b/doc/Axlsx/Border.html @@ -0,0 +1,775 @@ +<!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::Border + + — 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 (B)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">Border</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::Border + + + +</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::Border</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/stylesheet/border.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +This class details a border used in Office Open XML spreadsheet styles. +</p> + + + </div> +</div> +<div class="tags"> + + +</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="#diagonalDown-instance_method" title="#diagonalDown (instance method)">- (Boolean) <strong>diagonalDown</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The diagonal down property for the border that indicates if the border +should include a diagonal line from the top left to the top right of the +cell. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#diagonalUp-instance_method" title="#diagonalUp (instance method)">- (Boolean) <strong>diagonalUp</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The diagonal up property for the border that indicates if the border should +include a diagonal line from the bottom left to the top right of the cell. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#outline-instance_method" title="#outline (instance method)">- (Boolean) <strong>outline</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The outline property for the border indicating that top, left, right and +bottom borders should only be applied to the outside border of a range of +cells. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#prs-instance_method" title="#prs (instance method)">- (SimpleTypedList) <strong>prs</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +A list of BorderPr objects for this border. +</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)">- (Border) <strong>initialize</strong>(options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new Border object. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#to_xml-instance_method" title="#to_xml (instance method)">- (Object) <strong>to_xml</strong>(xml) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Serializes the border element. +</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::Border (class)">Border</a></span></tt>) <strong>initialize</strong>(options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new Border object +</p> + + + </div> +</div> +<div class="tags"> + + <div class="examples"> + <h3>Examples:</h3> + + <h4><div class='inline'><p> +Making a border +</p> +</div></h4> + <pre class="example code"><span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> +<span class='red_border identifier id'>red_border</span> <span class='assign token'>=</span> <span class='Border constant id'>Border</span><span class='dot token'>.</span><span class='new identifier id'>new</span> +<span class='lbrack token'>[</span><span class='symbol val'>:left</span><span class='comma token'>,</span> <span class='symbol val'>:right</span><span class='comma token'>,</span> <span class='symbol val'>:top</span><span class='comma token'>,</span> <span class='symbol val'>:bottom</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='item identifier id'>item</span><span class='bitor op'>|</span> + <span class='red_border identifier id'>red_border</span><span class='dot token'>.</span><span class='prs identifier id'>prs</span> <span class='lshft op'><<</span> <span class='BorderPr constant id'>BorderPr</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:name=</span><span class='gt op'>></span><span class='item identifier id'>item</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='symbol val'>:thin</span><span class='comma token'>,</span> <span class='symbol val'>:color=</span><span class='gt op'>></span><span class='Color constant id'>Color</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:rgb=</span><span class='gt op'>></span><span class='string val'>"FFFF0000"</span><span class='rparen token'>)</span><span class='rparen token'>)</span> <span class='comment val'># </span> +<span class='end end kw'>end</span> +<span class='comment val'># this sets red_border to be the index for the created border.</span> +<span class='red_border identifier id'>red_border</span> <span class='assign token'>=</span> <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='@borders ivar id'>@borders</span> <span class='lshft op'><<</span> <span class='red_border identifier id'>red_border</span> +<span class='comment val'>#used in row creation as follows. This will add a red border to each of the cells in the row.</span> +<span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span> <span class='lshft op'><<</span> <span class='symbol val'>:values=</span><span class='gt op'>></span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span><span class='integer val'>2</span><span class='comma token'>,</span><span class='integer val'>3</span><span class='rbrack token'>]</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='red_border identifier id'>red_border</span> +</pre> + + </div> +<h3>Parameters:</h3> +<ul class="param"> + + <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">diagonalUp</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">diagonalDown</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">outline</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +31 +32 +33 +34 +35 +36</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border.rb', line 31</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='@prs ivar id'>@prs</span> <span class='assign token'>=</span> <span class='SimpleTypedList constant id'>SimpleTypedList</span><span class='dot token'>.</span><span class='new identifier id'>new</span> <span class='BorderPr constant id'>BorderPr</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="diagonalDown=-instance_method"></span> + <span id="diagonalDown-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="diagonalDown-instance_method"> + + - (<tt>Boolean</tt>) <strong>diagonalDown</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The diagonal down property for the border that indicates if the border +should include a diagonal line from the top left to the top right of the +cell. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + — + <div class='inline'><p> +The diagonal down property for the border that indicates if the border +should include a diagonal line from the top left to the top right of the +cell. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +9 +10 +11</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border.rb', line 9</span> + +<span class='def def kw'>def</span> <span class='diagonalDown identifier id'>diagonalDown</span> + <span class='@diagonalDown ivar id'>@diagonalDown</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="diagonalUp=-instance_method"></span> + <span id="diagonalUp-instance_method"></span> + <div class="method_details "> + <p class="signature " id="diagonalUp-instance_method"> + + - (<tt>Boolean</tt>) <strong>diagonalUp</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The diagonal up property for the border that indicates if the border should +include a diagonal line from the bottom left to the top right of the cell. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + — + <div class='inline'><p> +The diagonal up property for the border that indicates if the border should +include a diagonal line from the bottom left to the top right of the cell. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +6 +7 +8</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border.rb', line 6</span> + +<span class='def def kw'>def</span> <span class='diagonalUp identifier id'>diagonalUp</span> + <span class='@diagonalUp ivar id'>@diagonalUp</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="outline=-instance_method"></span> + <span id="outline-instance_method"></span> + <div class="method_details "> + <p class="signature " id="outline-instance_method"> + + - (<tt>Boolean</tt>) <strong>outline</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The outline property for the border indicating that top, left, right and +bottom borders should only be applied to the outside border of a range of +cells. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + — + <div class='inline'><p> +The outline property for the border indicating that top, left, right and +bottom borders should only be applied to the outside border of a range of +cells. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +12 +13 +14</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border.rb', line 12</span> + +<span class='def def kw'>def</span> <span class='outline identifier id'>outline</span> + <span class='@outline ivar id'>@outline</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="prs-instance_method"></span> + <div class="method_details "> + <p class="signature " id="prs-instance_method"> + + - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>prs</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +A list of BorderPr objects for this border. +</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> + + + + — + <div class='inline'><p> +A list of BorderPr objects for this border. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +15 +16 +17</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border.rb', line 15</span> + +<span class='def def kw'>def</span> <span class='prs identifier id'>prs</span> + <span class='@prs ivar id'>@prs</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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>Object</tt>) <strong>to_xml</strong>(xml) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Serializes the border element +</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> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +44 +45 +46 +47 +48 +49 +50</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border.rb', line 44</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='border identifier id'>border</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='dot token'>.</span><span class='select identifier id'>select</span><span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='k identifier id'>k</span><span class='comma token'>,</span><span class='v identifier id'>v</span><span class='bitor op'>|</span> <span class='lbrack token'>[</span><span class='symbol val'>:diagonalUp</span><span class='comma token'>,</span> <span class='symbol val'>:diagonalDown</span><span class='comma token'>,</span> <span class='symbol val'>:outline</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='include? fid id'>include?</span> <span class='k identifier id'>k</span> <span class='rbrace token'>}</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='lbrack token'>[</span><span class='symbol val'>:start</span><span class='comma token'>,</span> <span class='symbol val'>:end</span><span class='comma token'>,</span> <span class='symbol val'>:left</span><span class='comma token'>,</span> <span class='symbol val'>:right</span><span class='comma token'>,</span> <span class='symbol val'>:top</span><span class='comma token'>,</span> <span class='symbol val'>:bottom</span><span class='comma token'>,</span> <span class='symbol val'>:diagonal</span><span class='comma token'>,</span> <span class='symbol val'>:vertical</span><span class='comma token'>,</span> <span class='symbol val'>:horizontal</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='k identifier id'>k</span><span class='bitor op'>|</span> + <span class='@prs ivar id'>@prs</span><span class='dot token'>.</span><span class='select identifier id'>select</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='pr identifier id'>pr</span><span class='bitor op'>|</span> <span class='pr identifier id'>pr</span><span class='dot token'>.</span><span class='name identifier id'>name</span> <span class='eq op'>==</span> <span class='k identifier id'>k</span> <span class='rbrace token'>}</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='pr identifier id'>pr</span><span class='bitor op'>|</span> <span class='pr identifier id'>pr</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43:58 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/BorderPr.html b/doc/Axlsx/BorderPr.html new file mode 100644 index 00000000..72d6b7a0 --- /dev/null +++ b/doc/Axlsx/BorderPr.html @@ -0,0 +1,709 @@ +<!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::BorderPr + + — 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 (B)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">BorderPr</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::BorderPr + + + +</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::BorderPr</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/stylesheet/border_pr.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +A border part. +</p> + + + </div> +</div> +<div class="tags"> + + +</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="#color-instance_method" title="#color (instance method)">- (Color) <strong>color</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The color of this border part. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#name-instance_method" title="#name (instance method)">- (Symbol) <strong>name</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The name of this border part. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#style-instance_method" title="#style (instance method)">- (Symbol) <strong>style</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The syle of this border part. +</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)">- (BorderPr) <strong>initialize</strong>(options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new Border Part Object. +</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 border part. +</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::BorderPr (class)">BorderPr</a></span></tt>) <strong>initialize</strong>(options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new Border Part Object +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <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">color</span> + <span class="type">(<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">name</span> + <span class="type">(<tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">style</span> + <span class="type">(<tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="Border.html" title="Axlsx::Border (class)">Axlsx::Border</a></span></li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +46 +47 +48 +49 +50</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border_pr.rb', line 46</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='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="color=-instance_method"></span> + <span id="color-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="color-instance_method"> + + - (<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>) <strong>color</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The color of this border part. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>)</span> + + + + — + <div class='inline'><p> +The color of this border part. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +6 +7 +8</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border_pr.rb', line 6</span> + +<span class='def def kw'>def</span> <span class='color identifier id'>color</span> + <span class='@color ivar id'>@color</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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>Symbol</tt>) <strong>name</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +The following are allowed +</p> +<pre class="code"> + <span class='symbol val'>:start</span> + <span class='symbol val'>:end</span> + <span class='symbol val'>:left</span> + <span class='symbol val'>:right</span> + <span class='symbol val'>:top</span> + <span class='symbol val'>:bottom</span> + <span class='symbol val'>:diagonal</span> + <span class='symbol val'>:vertical</span> + <span class='symbol val'>:horizontal</span> +</pre> +</div> + </div> + +<p> +The name of this border part +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Symbol</tt>)</span> + + + + — + <div class='inline'><p> +The name of this border part +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +39 +40 +41</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border_pr.rb', line 39</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="style=-instance_method"></span> + <span id="style-instance_method"></span> + <div class="method_details "> + <p class="signature " id="style-instance_method"> + + - (<tt>Symbol</tt>) <strong>style</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +The following are allowed +</p> +<pre class="code"> + <span class='symbol val'>:none</span> + <span class='symbol val'>:thin</span> + <span class='symbol val'>:medium</span> + <span class='symbol val'>:dashed</span> + <span class='symbol val'>:dotted</span> + <span class='symbol val'>:thick</span> + <span class='symbol val'>:double</span> + <span class='symbol val'>:hair</span> + <span class='symbol val'>:mediumDashed</span> + <span class='symbol val'>:dashDot</span> + <span class='symbol val'>:mediumDashDot</span> + <span class='symbol val'>:dashDotDot</span> + <span class='symbol val'>:mediumDashDotDot</span> + <span class='symbol val'>:slantDashDot</span> +</pre> +</div> + </div> + +<p> +The syle of this border part. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Symbol</tt>)</span> + + + + — + <div class='inline'><p> +The syle of this border part. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +25 +26 +27</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border_pr.rb', line 25</span> + +<span class='def def kw'>def</span> <span class='style identifier id'>style</span> + <span class='@style ivar id'>@style</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 border part +</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"> + + +59 +60 +61 +62 +63</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border_pr.rb', line 59</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='@name ivar id'>@name</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='@style ivar id'>@style</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='@color ivar id'>@color</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='@color ivar id'>@color</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span> <span class='Color constant id'>Color</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43: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> + + </body> +</html>
\ No newline at end of file diff --git a/doc/Axlsx/CatAxis.html b/doc/Axlsx/CatAxis.html new file mode 100644 index 00000000..235e4a50 --- /dev/null +++ b/doc/Axlsx/CatAxis.html @@ -0,0 +1,766 @@ +<!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::CatAxis + + — 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 (C)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">CatAxis</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::CatAxis + + + +</h1> + +<dl class="box"> + + <dt class="r1">Inherits:</dt> + <dd class="r1"> + <span class="inheritName"><span class='object_link'><a href="Axis.html" title="Axlsx::Axis (class)">Axis</a></span></span> + + <ul class="fullTree"> + <li>Object</li> + + <li class="next"><span class='object_link'><a href="Axis.html" title="Axlsx::Axis (class)">Axis</a></span></li> + + <li class="next">Axlsx::CatAxis</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/drawing/cat_axis.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +A CatAxis object defines a chart category axis +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + <h2>Constant Summary</h2> + + <dl class="constants"> + + <dt id="LBL_OFFSET_REGEX-constant" class="">LBL_OFFSET_REGEX = + <div class="docstring"> + <div class="discussion"> + <p> +regex for validating label offset +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='regexp val'>/0*(([0-9])|([1-9][0-9])|([1-9][0-9][0-9])|1000)%/</span> +</pre></dd> + + </dl> + + + + + + + + <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="#auto-instance_method" title="#auto (instance method)">- (Boolean) <strong>auto</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +From the docs: This element specifies that this axis is a date or text axis +based on the data that is used for the axis labels, not a specific choice. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#lblAlgn-instance_method" title="#lblAlgn (instance method)">- (Symbol) <strong>lblAlgn</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +specifies how the perpendicular axis is crossed must be one of [:ctr, :l, +:r]. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#lblOffset-instance_method" title="#lblOffset (instance method)">- (Integer) <strong>lblOffset</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The offset of the labels must be between a string between 0 and 1000. +</p> +</div></span> + +</li> + + + </ul> + + + + + + + + + <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Axis.html" title="Axlsx::Axis (class)">Axis</a></span></h3> + <p class="inherited"><span class='object_link'><a href="Axis.html#axId-instance_method" title="Axlsx::Axis#axId (method)">axId</a></span>, <span class='object_link'><a href="Axis.html#axPos-instance_method" title="Axlsx::Axis#axPos (method)">axPos</a></span>, <span class='object_link'><a href="Axis.html#crossAx-instance_method" title="Axlsx::Axis#crossAx (method)">crossAx</a></span>, <span class='object_link'><a href="Axis.html#crosses-instance_method" title="Axlsx::Axis#crosses (method)">crosses</a></span>, <span class='object_link'><a href="Axis.html#format_code-instance_method" title="Axlsx::Axis#format_code (method)">format_code</a></span>, <span class='object_link'><a href="Axis.html#scaling-instance_method" title="Axlsx::Axis#scaling (method)">scaling</a></span>, <span class='object_link'><a href="Axis.html#tickLblPos-instance_method" title="Axlsx::Axis#tickLblPos (method)">tickLblPos</a></span></p> + + + + <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)">- (CatAxis) <strong>initialize</strong>(axId, crossAx, options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new CatAxis object. +</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 category axis. +</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::CatAxis (class)">CatAxis</a></span></tt>) <strong>initialize</strong>(axId, crossAx, options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new CatAxis object +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>axId</span> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +the id of this axis +</p> +</div> + + </li> + + <li> + + <span class='name'>crossAx</span> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +the id of the perpendicular axis +</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">axPos</span> + <span class="type">(<tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">tickLblPos</span> + <span class="type">(<tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">crosses</span> + <span class="type">(<tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">auto</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">lblAlgn</span> + <span class="type">(<tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">lblOffset</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +30 +31 +32 +33 +34 +35 +36 +37 +38</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.rb', line 30</span> + +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='axId identifier id'>axId</span><span class='comma token'>,</span> <span class='crossAx identifier id'>crossAx</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='axId identifier id'>axId</span><span class='comma token'>,</span> <span class='crossAx identifier id'>crossAx</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='auto identifier id'>auto</span> <span class='assign token'>=</span> <span class='true true kw'>true</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='lblAlgn identifier id'>lblAlgn</span> <span class='assign token'>=</span> <span class='symbol val'>:ctr</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='lblOffset identifier id'>lblOffset</span> <span class='assign token'>=</span> <span class='string val'>"100%"</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="auto=-instance_method"></span> + <span id="auto-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="auto-instance_method"> + + - (<tt>Boolean</tt>) <strong>auto</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +From the docs: This element specifies that this axis is a date or text axis +based on the data that is used for the axis labels, not a specific choice. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +6 +7 +8</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.rb', line 6</span> + +<span class='def def kw'>def</span> <span class='auto identifier id'>auto</span> + <span class='@auto ivar id'>@auto</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="lblAlgn=-instance_method"></span> + <span id="lblAlgn-instance_method"></span> + <div class="method_details "> + <p class="signature " id="lblAlgn-instance_method"> + + - (<tt>Symbol</tt>) <strong>lblAlgn</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +specifies how the perpendicular axis is crossed must be one of [:ctr, :l, +:r] +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Symbol</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +11 +12 +13</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.rb', line 11</span> + +<span class='def def kw'>def</span> <span class='lblAlgn identifier id'>lblAlgn</span> + <span class='@lblAlgn ivar id'>@lblAlgn</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="lblOffset=-instance_method"></span> + <span id="lblOffset-instance_method"></span> + <div class="method_details "> + <p class="signature " id="lblOffset-instance_method"> + + - (<tt>Integer</tt>) <strong>lblOffset</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The offset of the labels must be between a string between 0 and 1000 +</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"> + + +16 +17 +18</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.rb', line 16</span> + +<span class='def def kw'>def</span> <span class='lblOffset identifier id'>lblOffset</span> + <span class='@lblOffset ivar id'>@lblOffset</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 category axis +</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"> + + +47 +48 +49 +50 +51 +52 +53 +54</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.rb', line 47</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:catAx'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:auto'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@auto ivar id'>@auto</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:lblAlgn'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@lblAlgn ivar id'>@lblAlgn</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:lblOffset'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@lblOffset ivar id'>@lblOffset</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:44:03 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/Cell.html b/doc/Axlsx/Cell.html new file mode 100644 index 00000000..3dfc11f1 --- /dev/null +++ b/doc/Axlsx/Cell.html @@ -0,0 +1,1623 @@ +<!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::Cell + + — 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 (C)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">Cell</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::Cell + + + +</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::Cell</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/workbook/worksheet/cell.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 generate cells is via Worksheet#add_row +</p> +</div> + </div> + +<p> +A cell in a worksheet. Cell stores inforamation requried to serialize a +single worksheet cell to xml. You must provde the Row that the cell belongs +to and the cells value. The data type will automatically be determed if you +do not specify the :type option. The default style will be applied if you +do not supply the :style option. Changing the cell’s type will recast +the value to the type specified. Altering the cell’s value via the +property accessor will also automatically cast the provided value to the +cell’s type. +</p> + + + </div> +</div> +<div class="tags"> + + <div class="examples"> + <h3>Examples:</h3> + + <h4><div class='inline'><p> +Manually creating and manipulating Cell objects +</p> +</div></h4> + <pre class="example code"><span class='ws identifier id'>ws</span> <span class='assign token'>=</span> <span class='Workbook constant id'>Workbook</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> +<span class='comment val'># This is the simple, and recommended way to create cells. Data types will automatically be determined for you.</span> +<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span><span class='string val'>"fish"</span><span class='comma token'>,</span><span class='Time constant id'>Time</span><span class='dot token'>.</span><span class='now identifier id'>now</span><span class='rbrack token'>]</span> + +<span class='comment val'># but you can also do this</span> +<span class='r identifier id'>r</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> +<span class='r identifier id'>r</span><span class='dot token'>.</span><span class='add_cell identifier id'>add_cell</span> <span class='integer val'>1</span> + +<span class='comment val'># or even this</span> +<span class='r identifier id'>r</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> +<span class='c identifier id'>c</span> <span class='assign token'>=</span> <span class='Cell constant id'>Cell</span><span class='dot token'>.</span><span class='new identifier id'>new</span> <span class='row identifier id'>row</span><span class='comma token'>,</span> <span class='integer val'>1</span><span class='comma token'>,</span> <span class='symbol val'>:value=</span><span class='gt op'>></span><span class='integer identifier id'>integer</span> + +<span class='comment val'># cells can also be accessed via Row#cells. The example here changes the cells type, which will automatically updated the value from 1 to 1.0</span> +<span class='r identifier id'>r</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='type identifier id'>type</span> <span class='assign token'>=</span> <span class='symbol val'>:float</span> +</pre> + + </div> + + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="Worksheet.html#add_row-instance_method" title="Axlsx::Worksheet#add_row (method)">Worksheet#add_row</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="#row-instance_method" title="#row (instance method)">- (Row) <strong>row</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The row this cell belongs to. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#style-instance_method" title="#style (instance method)">- (Integer) <strong>style</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The index of the cellXfs item to be applied to this cell. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#type-instance_method" title="#type (instance method)">- (Symbol) <strong>type</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The cell’s data type. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#value-instance_method" title="#value (instance method)">- (Object) <strong>value</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The value of this cell. +</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="#cast_value-instance_method" title="#cast_value (instance method)">- (Object) <strong>cast_value</strong>(v) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Cast the value into this cells data type. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#cell_type_from_value-instance_method" title="#cell_type_from_value (instance method)">- (Symbol) <strong>cell_type_from_value</strong>(v) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Determines the cell type based on the cell value. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#col_ref-instance_method" title="#col_ref (instance method)">- (String) <strong>col_ref</strong> </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +converts the column index into alphabetical values. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#index-instance_method" title="#index (instance method)">- (Integer) <strong>index</strong> </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The index of the cell in the containing row. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#initialize-instance_method" title="#initialize (instance method)">- (Cell) <strong>initialize</strong>(row, value = "", options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +A new instance of Cell. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#r-instance_method" title="#r (instance method)">- (String) <strong>r</strong> </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The alpha(column)numeric(row) reference for this sell. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#r_abs-instance_method" title="#r_abs (instance method)">- (String) <strong>r_abs</strong> </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The absolute alpha(column)numeric(row) reference for this sell. +</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 cell. +</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::Cell (class)">Cell</a></span></tt>) <strong>initialize</strong>(row, value = "", options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +A new instance of Cell +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>row</span> + + + <span class='type'>(<tt><span class='object_link'><a href="Row.html" title="Axlsx::Row (class)">Row</a></span></tt>)</span> + + + + — + <div class='inline'><p> +The row this cell belongs to. +</p> +</div> + + </li> + + <li> + + <span class='name'>value</span> + + + <span class='type'>(<tt>Any</tt>)</span> + + + <em class="default">(defaults to: <tt>""</tt>)</em> + + + — + <div class='inline'><p> +The value associated with this cell. +</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">type</span> + <span class="type">(<tt>Symbol</tt>)</span> + <span class="default"> + + </span> + — <div class='inline'><p> +The intended data type for this cell. If not specified the data type will +be determined internally based on the vlue provided. +</p> +</div> + </li> + + <li> + <span class="name">style</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + — <div class='inline'><p> +The index of the cellXfs item to be applied to this cell. If not specified, +the default style (0) will be applied. +</p> +</div> + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +56 +57 +58 +59 +60 +61 +62 +63 +64</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 56</span> + +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='row identifier id'>row</span><span class='comma token'>,</span> <span class='value identifier id'>value</span><span class='assign token'>=</span><span class='string val'>""</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='row identifier id'>row</span><span class='assign token'>=</span><span class='row identifier id'>row</span> + <span class='comment val'>#reference for validation</span> + <span class='@styles ivar id'>@styles</span> <span class='assign token'>=</span> <span class='row identifier id'>row</span><span class='dot token'>.</span><span class='worksheet identifier id'>worksheet</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span> + <span class='@type ivar id'>@type</span><span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:type</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='cell_type_from_value identifier id'>cell_type_from_value</span><span class='lparen token'>(</span><span class='value identifier id'>value</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='style identifier id'>style</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:style</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='integer val'>0</span> + <span class='@value ivar id'>@value</span> <span class='assign token'>=</span> <span class='cast_value identifier id'>cast_value</span><span class='lparen token'>(</span><span class='value identifier id'>value</span><span class='rparen token'>)</span> + <span class='@row ivar id'>@row</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span> <span class='lshft op'><<</span> <span class='self self kw'>self</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="row=-instance_method"></span> + <span id="row-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="row-instance_method"> + + - (<tt><span class='object_link'><a href="Row.html" title="Axlsx::Row (class)">Row</a></span></tt>) <strong>row</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The row this cell belongs to. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Row.html" title="Axlsx::Row (class)">Row</a></span></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/workbook/worksheet/cell.rb', line 32</span> + +<span class='def def kw'>def</span> <span class='row identifier id'>row</span> + <span class='@row ivar id'>@row</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="style=-instance_method"></span> + <span id="style-instance_method"></span> + <div class="method_details "> + <p class="signature " id="style-instance_method"> + + - (<tt>Integer</tt>) <strong>style</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The index of the cellXfs item to be applied to this cell. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + </li> + +</ul> + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="Styles.html" title="Axlsx::Styles (class)">Styles</a></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/workbook/worksheet/cell.rb', line 28</span> + +<span class='def def kw'>def</span> <span class='style identifier id'>style</span> + <span class='@style ivar id'>@style</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="type=-instance_method"></span> + <span id="type-instance_method"></span> + <div class="method_details "> + <p class="signature " id="type-instance_method"> + + - (<tt>Symbol</tt>) <strong>type</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +If the value provided cannot be cast into the type specified, type is +changed to :string and the following logic is applied. +</p> +<pre class="code"> + <span class='symbol val'>:string</span> <span class='to identifier id'>to</span> <span class='symbol val'>:integer</span> <span class='or or kw'>or</span> <span class='symbol val'>:float</span><span class='comma token'>,</span> <span class='type identifier id'>type</span> <span class='coversions identifier id'>coversions</span> <span class='always identifier id'>always</span> <span class='return return kw'>return</span> <span class='integer val'>0</span> <span class='or or kw'>or</span> <span class='integer val'>0</span><span class='integer val'>.0</span> + <span class='symbol val'>:string</span><span class='comma token'>,</span> <span class='symbol val'>:integer</span><span class='comma token'>,</span> <span class='or or kw'>or</span> <span class='symbol val'>:float</span> <span class='to identifier id'>to</span> <span class='symbol val'>:time</span> <span class='conversions identifier id'>conversions</span> <span class='always identifier id'>always</span> <span class='return return kw'>return</span> <span class='the identifier id'>the</span> <span class='original identifier id'>original</span> <span class='value identifier id'>value</span> <span class='as identifier id'>as</span> <span class='a identifier id'>a</span> <span class='string identifier id'>string</span> <span class='and and kw'>and</span> <span class='set identifier id'>set</span> <span class='the identifier id'>the</span> <span class='cells identifier id'>cells</span> <span class='type identifier id'>type</span> <span class='to identifier id'>to</span> <span class='symbol val'>:string</span><span class='dot token'>.</span> +</pre> +<p> +No support is currently implemented for parsing time strings. +</p> +</div> + </div> + +<p> +The cell’s data type. Currently only four types are supported, :time, +:float, :integer and :string. Changing the type for a cell will recast the +value into that type. If no type option is specified in the constructor, +the type is automatically determed. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Symbol</tt>)</span> + + + + — + <div class='inline'><p> +The type of data this cell’s value is cast to. +</p> +</div> + + </li> + +</ul> +<h3>Raises:</h3> +<ul class="raise"> + + <li> + + + <span class='type'>(<tt>ArgumentExeption</tt>)</span> + + + + — + <div class='inline'><p> +Cell.type must be one of [:time, :float, :integer, :string] +</p> +</div> + + </li> + +</ul> + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="#cell_type_from_value-instance_method" title="Axlsx::Cell#cell_type_from_value (method)">#cell_type_from_value</a></span></li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +46 +47 +48</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 46</span> + +<span class='def def kw'>def</span> <span class='type identifier id'>type</span> + <span class='@type ivar id'>@type</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="value=-instance_method"></span> + <span id="value-instance_method"></span> + <div class="method_details "> + <p class="signature " id="value-instance_method"> + + - (<tt>Object</tt>) <strong>value</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The value of this cell. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'></span> + + + + + <div class='inline'><p> +casted value based on cell’s type attribute. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +50 +51 +52</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 50</span> + +<span class='def def kw'>def</span> <span class='value identifier id'>value</span> + <span class='@value ivar id'>@value</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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="cast_value-instance_method"> + + - (<tt>Object</tt>) <strong>cast_value</strong>(v) + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +About Time - Time in OOXML is <b>different</b> from what you might expect. +The history as to why is interesting, but you can safely assume that if you +are generating docs on a mac, you will want to specify Workbook.1904 as +true when using time typed values. +</p> +</div> + </div> + +<p> +Cast the value into this cells data type. +</p> + + + </div> +</div> +<div class="tags"> + + + <h3>See Also:</h3> + <ul class="see"> + + <li>Axlsx#date1904</li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 160</span> + +<span class='def def kw'>def</span> <span class='cast_value identifier id'>cast_value</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='if if kw'>if</span> <span class='@type ivar id'>@type</span> <span class='eq op'>==</span> <span class='symbol val'>:time</span> <span class='andop op'>&&</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Time constant id'>Time</span><span class='rparen token'>)</span> + <span class='comment val'>#todo consider a time parsing method to convert strings to time</span> + <span class='epoc identifier id'>epoc</span> <span class='assign token'>=</span> <span class='Workbook constant id'>Workbook</span><span class='dot token'>.</span><span class='date1904 identifier id'>date1904</span> <span class='integer val'>? </span><span class='Time constant id'>Time</span><span class='dot token'>.</span><span class='local identifier id'>local</span><span class='lparen token'>(</span><span class='integer val'>1904</span><span class='comma token'>,</span><span class='integer val'>1</span><span class='comma token'>,</span><span class='integer val'>1</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='v identifier id'>v</span><span class='dot token'>.</span><span class='zone identifier id'>zone</span><span class='rparen token'>)</span> <span class='colon op'>:</span> <span class='Time constant id'>Time</span><span class='dot token'>.</span><span class='local identifier id'>local</span><span class='lparen token'>(</span><span class='integer val'>1900</span><span class='comma token'>,</span><span class='integer val'>1</span><span class='comma token'>,</span><span class='integer val'>1</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='v identifier id'>v</span><span class='dot token'>.</span><span class='zone identifier id'>zone</span><span class='rparen token'>)</span> + <span class='lparen token'>(</span><span class='lparen token'>(</span><span class='v identifier id'>v</span> <span class='minus op'>-</span> <span class='epoc identifier id'>epoc</span><span class='rparen token'>)</span> <span class='div op'>/</span><span class='float val'>60.0</span><span class='div op'>/</span><span class='float val'>60.0</span><span class='div op'>/</span><span class='float val'>24.0</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='to_f identifier id'>to_f</span> + <span class='elsif elsif kw'>elsif</span> <span class='@type ivar id'>@type</span> <span class='eq op'>==</span> <span class='symbol val'>:float</span> + <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_f identifier id'>to_f</span> + <span class='elsif elsif kw'>elsif</span> <span class='@type ivar id'>@type</span> <span class='eq op'>==</span> <span class='symbol val'>:integer</span> + <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_i identifier id'>to_i</span> + <span class='else else kw'>else</span> + <span class='@type ivar id'>@type</span> <span class='assign token'>=</span> <span class='symbol val'>:string</span> + <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span> + <span class='comment val'># curious as to why this would be the cells responsibility</span> + <span class='comment val'># convert your values before passing them in wankers! CGI.unescapeHTML(v.to_s).to_xs</span> + <span class='comment val'># to revert, load this once when the gem is loaded.</span> + <span class='comment val'># unless String.method_defined? :to_xs</span> + <span class='comment val'># require 'fast_xs' #dep</span> + <span class='comment val'># class String</span> + <span class='comment val'># alias_method :to_xs, :fast_xs</span> + <span class='comment val'># end</span> + <span class='comment val'># end</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="cell_type_from_value-instance_method"> + + - (<tt>Symbol</tt>) <strong>cell_type_from_value</strong>(v) + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +This is only used when a cell is created but no :type option is specified, +the following rules apply: +</p> +<ol> +<li>If the value is an instance of Time, the type is set to :time + +</li> +<li>:float and :integer types are determined by regular expression matching. + +</li> +<li>Anything that does not meet either of the above is determined to be +:string. + +</li> +</ol> +</div> + </div> + +<p> +Determines the cell type based on the cell value. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Symbol</tt>)</span> + + + + — + <div class='inline'><p> +The determined type +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +144 +145 +146 +147 +148 +149 +150 +151 +152 +153 +154</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 144</span> + +<span class='def def kw'>def</span> <span class='cell_type_from_value identifier id'>cell_type_from_value</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='if if kw'>if</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span> <span class='Time constant id'>Time</span> + <span class='symbol val'>:time</span> + <span class='elsif elsif kw'>elsif</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='dot token'>.</span><span class='match identifier id'>match</span><span class='lparen token'>(</span><span class='regexp val'>/\A[+-]?\d+?\Z/</span><span class='rparen token'>)</span> <span class='comment val'>#numeric</span> + <span class='symbol val'>:integer</span> + <span class='elsif elsif kw'>elsif</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='dot token'>.</span><span class='match identifier id'>match</span><span class='lparen token'>(</span><span class='regexp val'>/\A[+-]?\d+\.\d+?\Z/</span><span class='rparen token'>)</span> <span class='comment val'>#float</span> + <span class='symbol val'>:float</span> + <span class='else else kw'>else</span> + <span class='symbol val'>:string</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="col_ref-instance_method"> + + - (<tt>String</tt>) <strong>col_ref</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +This follows the standard spreadsheet convention of naming columns A to Z, +followed by AA to AZ etc. +</p> +</div> + </div> + +<p> +converts the column index into alphabetical values. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +127 +128 +129 +130 +131 +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 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172 +173 +174 +175 +176 +177 +178 +179 +180 +181 +182 +183</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 127</span> + +<span class='def def kw'>def</span> <span class='col_ref identifier id'>col_ref</span> + <span class='chars identifier id'>chars</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span> + <span class='index identifier id'>index</span> <span class='assign token'>=</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='index identifier id'>index</span> + <span class='while while kw'>while</span> <span class='index identifier id'>index</span> <span class='geq op'>>=</span> <span class='integer val'>26</span> <span class='do do kw'>do</span> + <span class='chars identifier id'>chars</span> <span class='lshft op'><<</span> <span class='lparen token'>(</span><span class='lparen token'>(</span><span class='index identifier id'>index</span> <span class='mod op'>%</span> <span class='integer val'>26</span><span class='rparen token'>)</span> <span class='plus op'>+</span> <span class='integer val'>65</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='chr identifier id'>chr</span> + <span class='index identifier id'>index</span> <span class='opasgn op'>/=</span> <span class='integer val'>26</span> + <span class='end end kw'>end</span> + <span class='chars identifier id'>chars</span> <span class='lshft op'><<</span> <span class='lparen token'>(</span><span class='lparen token'>(</span><span class='chars identifier id'>chars</span><span class='dot token'>.</span><span class='empty? fid id'>empty?</span> <span class='integer val'>? </span><span class='index identifier id'>index</span> <span class='colon op'>:</span> <span class='index identifier id'>index</span><span class='minus op'>-</span><span class='integer val'>1</span><span class='rparen token'>)</span> <span class='plus op'>+</span> <span class='integer val'>65</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='chr identifier id'>chr</span> + <span class='chars identifier id'>chars</span><span class='dot token'>.</span><span class='reverse identifier id'>reverse</span><span class='dot token'>.</span><span class='join identifier id'>join</span> + <span class='end end kw'>end</span> + + <span class='comment val'># Determines the cell type based on the cell value. </span> + <span class='comment val'># @note This is only used when a cell is created but no :type option is specified, the following rules apply:</span> + <span class='comment val'># 1. If the value is an instance of Time, the type is set to :time</span> + <span class='comment val'># 2. :float and :integer types are determined by regular expression matching.</span> + <span class='comment val'># 3. Anything that does not meet either of the above is determined to be :string.</span> + <span class='comment val'># @return [Symbol] The determined type</span> + <span class='def def kw'>def</span> <span class='cell_type_from_value identifier id'>cell_type_from_value</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='if if kw'>if</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span> <span class='Time constant id'>Time</span> + <span class='symbol val'>:time</span> + <span class='elsif elsif kw'>elsif</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='dot token'>.</span><span class='match identifier id'>match</span><span class='lparen token'>(</span><span class='regexp val'>/\A[+-]?\d+?\Z/</span><span class='rparen token'>)</span> <span class='comment val'>#numeric</span> + <span class='symbol val'>:integer</span> + <span class='elsif elsif kw'>elsif</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='dot token'>.</span><span class='match identifier id'>match</span><span class='lparen token'>(</span><span class='regexp val'>/\A[+-]?\d+\.\d+?\Z/</span><span class='rparen token'>)</span> <span class='comment val'>#float</span> + <span class='symbol val'>:float</span> + <span class='else else kw'>else</span> + <span class='symbol val'>:string</span> + <span class='end end kw'>end</span> + <span class='end end kw'>end</span> + + <span class='comment val'># Cast the value into this cells data type. </span> + <span class='comment val'># @note </span> + <span class='comment val'># About Time - Time in OOXML is *different* from what you might expect. The history as to why is interesting, but you can safely assume that if you are generating docs on a mac, you will want to specify Workbook.1904 as true when using time typed values.</span> + <span class='comment val'># @see Axlsx#date1904</span> + <span class='def def kw'>def</span> <span class='cast_value identifier id'>cast_value</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='if if kw'>if</span> <span class='@type ivar id'>@type</span> <span class='eq op'>==</span> <span class='symbol val'>:time</span> <span class='andop op'>&&</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Time constant id'>Time</span><span class='rparen token'>)</span> + <span class='comment val'>#todo consider a time parsing method to convert strings to time</span> + <span class='epoc identifier id'>epoc</span> <span class='assign token'>=</span> <span class='Workbook constant id'>Workbook</span><span class='dot token'>.</span><span class='date1904 identifier id'>date1904</span> <span class='integer val'>? </span><span class='Time constant id'>Time</span><span class='dot token'>.</span><span class='local identifier id'>local</span><span class='lparen token'>(</span><span class='integer val'>1904</span><span class='comma token'>,</span><span class='integer val'>1</span><span class='comma token'>,</span><span class='integer val'>1</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='v identifier id'>v</span><span class='dot token'>.</span><span class='zone identifier id'>zone</span><span class='rparen token'>)</span> <span class='colon op'>:</span> <span class='Time constant id'>Time</span><span class='dot token'>.</span><span class='local identifier id'>local</span><span class='lparen token'>(</span><span class='integer val'>1900</span><span class='comma token'>,</span><span class='integer val'>1</span><span class='comma token'>,</span><span class='integer val'>1</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='v identifier id'>v</span><span class='dot token'>.</span><span class='zone identifier id'>zone</span><span class='rparen token'>)</span> + <span class='lparen token'>(</span><span class='lparen token'>(</span><span class='v identifier id'>v</span> <span class='minus op'>-</span> <span class='epoc identifier id'>epoc</span><span class='rparen token'>)</span> <span class='div op'>/</span><span class='float val'>60.0</span><span class='div op'>/</span><span class='float val'>60.0</span><span class='div op'>/</span><span class='float val'>24.0</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='to_f identifier id'>to_f</span> + <span class='elsif elsif kw'>elsif</span> <span class='@type ivar id'>@type</span> <span class='eq op'>==</span> <span class='symbol val'>:float</span> + <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_f identifier id'>to_f</span> + <span class='elsif elsif kw'>elsif</span> <span class='@type ivar id'>@type</span> <span class='eq op'>==</span> <span class='symbol val'>:integer</span> + <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_i identifier id'>to_i</span> + <span class='else else kw'>else</span> + <span class='@type ivar id'>@type</span> <span class='assign token'>=</span> <span class='symbol val'>:string</span> + <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span> + <span class='comment val'># curious as to why this would be the cells responsibility</span> + <span class='comment val'># convert your values before passing them in wankers! CGI.unescapeHTML(v.to_s).to_xs</span> + <span class='comment val'># to revert, load this once when the gem is loaded.</span> + <span class='comment val'># unless String.method_defined? :to_xs</span> + <span class='comment val'># require 'fast_xs' #dep</span> + <span class='comment val'># class String</span> + <span class='comment val'># alias_method :to_xs, :fast_xs</span> + <span class='comment val'># end</span> + <span class='comment val'># end</span> + <span class='end end kw'>end</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="index-instance_method"> + + - (<tt>Integer</tt>) <strong>index</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The index of the cell in the containing row. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +The index of the cell in the containing row. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +67 +68 +69</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 67</span> + +<span class='def def kw'>def</span> <span class='index identifier id'>index</span> + <span class='@row ivar id'>@row</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="r-instance_method"> + + - (<tt>String</tt>) <strong>r</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The alpha(column)numeric(row) reference for this sell. +</p> + + + </div> +</div> +<div class="tags"> + + <div class="examples"> + <h3>Examples:</h3> + + <h4><div class='inline'><p> +Relative Cell Reference +</p> +</div></h4> + <pre class="example code"><span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='r identifier id'>r</span> <span class='comment val'>#=> "A1" </span> +</pre> + + </div> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +The alpha(column)numeric(row) reference for this sell. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +74 +75 +76</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 74</span> + +<span class='def def kw'>def</span> <span class='r identifier id'>r</span> + <span class='dstring node'>"#{col_ref}#{@row.index+1}"</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="r_abs-instance_method"> + + - (<tt>String</tt>) <strong>r_abs</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The absolute alpha(column)numeric(row) reference for this sell. +</p> + + + </div> +</div> +<div class="tags"> + + <div class="examples"> + <h3>Examples:</h3> + + <h4><div class='inline'><p> +Absolute Cell Reference +</p> +</div></h4> + <pre class="example code"><span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='r identifier id'>r</span> <span class='comment val'>#=> "$A$1" </span> +</pre> + + </div> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +The absolute alpha(column)numeric(row) reference for this sell. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +81 +82 +83</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 81</span> + +<span class='def def kw'>def</span> <span class='r_abs identifier id'>r_abs</span> + <span class='dstring node'>"$#{r.split('').join('$')}"</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +Shared Strings are not used in this library. All values are set directly in +the each sheet. +</p> +</div> + </div> + +<p> +Serializes the cell +</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> + + + + — + <div class='inline'><p> +xml text for the cell +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +110 +111 +112 +113 +114 +115 +116 +117</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 110</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='if if kw'>if</span> <span class='@type ivar id'>@type</span> <span class='eq op'>==</span> <span class='symbol val'>:string</span> + <span class='comment val'>#NOTE not sure why, but xml.t @v renders the text as html entities of unicode data</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='c identifier id'>c</span><span class='lparen token'>(</span><span class='symbol val'>:r</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='r identifier id'>r</span><span class='comma token'>,</span> <span class='symbol val'>:t=</span><span class='gt op'>></span><span class='symbol val'>:inlineStr</span><span class='comma token'>,</span> <span class='symbol val'>:s=</span><span class='gt op'>></span><span class='style identifier id'>style</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='is identifier id'>is</span> <span class='lbrace token'>{</span> <span class='xml identifier id'>xml</span> <span class='lshft op'><<</span> <span class='dstring node'>"<t>#{value}</t>"</span> <span class='rbrace token'>}</span> <span class='rbrace token'>}</span> + <span class='else else kw'>else</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='c identifier id'>c</span><span class='lparen token'>(</span><span class='symbol val'>:r</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='r identifier id'>r</span><span class='comma token'>,</span> <span class='symbol val'>:s</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='style identifier id'>style</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='v identifier id'>v</span> <span class='value identifier id'>value</span> <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43: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> + + </body> +</html>
\ No newline at end of file diff --git a/doc/Axlsx/CellAlignment.html b/doc/Axlsx/CellAlignment.html new file mode 100644 index 00000000..a541eb5e --- /dev/null +++ b/doc/Axlsx/CellAlignment.html @@ -0,0 +1,1247 @@ +<!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::CellAlignment + + — 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 (C)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">CellAlignment</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::CellAlignment + + + +</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::CellAlignment</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/stylesheet/cell_alignment.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> +Using Styles#add_style is the recommended way to manage cell alignment. +</p> +</div> + </div> + +<p> +CellAlignment stores information about the cell alignment of a style Xf +Object. +</p> + + + </div> +</div> +<div class="tags"> + + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="Styles.html#add_style-instance_method" title="Axlsx::Styles#add_style (method)">Styles#add_style</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="#horizontal-instance_method" title="#horizontal (instance method)">- (Symbol) <strong>horizontal</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The horizontal alignment of the cell. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#indent-instance_method" title="#indent (instance method)">- (Integer) <strong>indent</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The amount of indent. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#justifyLastLine-instance_method" title="#justifyLastLine (instance method)">- (Boolean) <strong>justifyLastLine</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Indicate if the last line should be justified. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#readingOrder-instance_method" title="#readingOrder (instance method)">- (Integer) <strong>readingOrder</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The reading order of the text 0 Context Dependent 1 Left-to-Right 2 +Right-to-Left. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#relativeIndent-instance_method" title="#relativeIndent (instance method)">- (Integer) <strong>relativeIndent</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The amount of relativeIndent. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#shrinkToFit-instance_method" title="#shrinkToFit (instance method)">- (Boolean) <strong>shrinkToFit</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Indicate if the text should be shrunk to the fit in the cell. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#textRotation-instance_method" title="#textRotation (instance method)">- (Integer) <strong>textRotation</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The textRotation of the cell. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#vertical-instance_method" title="#vertical (instance method)">- (Symbol) <strong>vertical</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The vertical alignment of the cell. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#wrapText-instance_method" title="#wrapText (instance method)">- (Boolean) <strong>wrapText</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Indicate if the text of the cell should wrap. +</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)">- (CellAlignment) <strong>initialize</strong>(options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Create a new cell_alignment object. +</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 cell alignment. +</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::CellAlignment (class)">CellAlignment</a></span></tt>) <strong>initialize</strong>(options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Create a new cell_alignment object +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <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">horizontal</span> + <span class="type">(<tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">vertical</span> + <span class="type">(<tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">textRotation</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">wrapText</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">indent</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">relativeIndent</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">justifyLastLine</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">shrinkToFit</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">readingOrder</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +72 +73 +74 +75 +76</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 72</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='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="horizontal=-instance_method"></span> + <span id="horizontal-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="horizontal-instance_method"> + + - (<tt>Symbol</tt>) <strong>horizontal</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +The horizontal cell alignement style must be one of +</p> +<pre class="code"> + <span class='symbol val'>:general</span> + <span class='symbol val'>:left</span> + <span class='symbol val'>:center</span> + <span class='symbol val'>:right</span> + <span class='symbol val'>:fill</span> + <span class='symbol val'>:justify</span> + <span class='symbol val'>:centerContinuous</span> + <span class='symbol val'>:distributed</span> +</pre> +</div> + </div> + +<p> +The horizontal alignment of the cell. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Symbol</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/stylesheet/cell_alignment.rb', line 18</span> + +<span class='def def kw'>def</span> <span class='horizontal identifier id'>horizontal</span> + <span class='@horizontal ivar id'>@horizontal</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="indent=-instance_method"></span> + <span id="indent-instance_method"></span> + <div class="method_details "> + <p class="signature " id="indent-instance_method"> + + - (<tt>Integer</tt>) <strong>indent</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The amount of indent +</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"> + + +41 +42 +43</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 41</span> + +<span class='def def kw'>def</span> <span class='indent identifier id'>indent</span> + <span class='@indent ivar id'>@indent</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="justifyLastLine=-instance_method"></span> + <span id="justifyLastLine-instance_method"></span> + <div class="method_details "> + <p class="signature " id="justifyLastLine-instance_method"> + + - (<tt>Boolean</tt>) <strong>justifyLastLine</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Indicate if the last line should be justified. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +49 +50 +51</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 49</span> + +<span class='def def kw'>def</span> <span class='justifyLastLine identifier id'>justifyLastLine</span> + <span class='@justifyLastLine ivar id'>@justifyLastLine</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="readingOrder=-instance_method"></span> + <span id="readingOrder-instance_method"></span> + <div class="method_details "> + <p class="signature " id="readingOrder-instance_method"> + + - (<tt>Integer</tt>) <strong>readingOrder</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The reading order of the text 0 Context Dependent 1 Left-to-Right 2 +Right-to-Left +</p> + + + </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"> + + +60 +61 +62</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 60</span> + +<span class='def def kw'>def</span> <span class='readingOrder identifier id'>readingOrder</span> + <span class='@readingOrder ivar id'>@readingOrder</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="relativeIndent=-instance_method"></span> + <span id="relativeIndent-instance_method"></span> + <div class="method_details "> + <p class="signature " id="relativeIndent-instance_method"> + + - (<tt>Integer</tt>) <strong>relativeIndent</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The amount of relativeIndent +</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"> + + +45 +46 +47</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 45</span> + +<span class='def def kw'>def</span> <span class='relativeIndent identifier id'>relativeIndent</span> + <span class='@relativeIndent ivar id'>@relativeIndent</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="shrinkToFit=-instance_method"></span> + <span id="shrinkToFit-instance_method"></span> + <div class="method_details "> + <p class="signature " id="shrinkToFit-instance_method"> + + - (<tt>Boolean</tt>) <strong>shrinkToFit</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Indicate if the text should be shrunk to the fit in the cell. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +53 +54 +55</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 53</span> + +<span class='def def kw'>def</span> <span class='shrinkToFit identifier id'>shrinkToFit</span> + <span class='@shrinkToFit ivar id'>@shrinkToFit</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="textRotation=-instance_method"></span> + <span id="textRotation-instance_method"></span> + <div class="method_details "> + <p class="signature " id="textRotation-instance_method"> + + - (<tt>Integer</tt>) <strong>textRotation</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The textRotation of the cell. +</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/stylesheet/cell_alignment.rb', line 33</span> + +<span class='def def kw'>def</span> <span class='textRotation identifier id'>textRotation</span> + <span class='@textRotation ivar id'>@textRotation</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="vertical=-instance_method"></span> + <span id="vertical-instance_method"></span> + <div class="method_details "> + <p class="signature " id="vertical-instance_method"> + + - (<tt>Symbol</tt>) <strong>vertical</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +The vertical cell allingment style must be one of the following: +</p> +<pre class="code"> + <span class='symbol val'>:top</span> + <span class='symbol val'>:center</span> + <span class='symbol val'>:bottom</span> + <span class='symbol val'>:justify</span> + <span class='symbol val'>:distributed</span> +</pre> +</div> + </div> + +<p> +The vertical alignment of the cell. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Symbol</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +29 +30 +31</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 29</span> + +<span class='def def kw'>def</span> <span class='vertical identifier id'>vertical</span> + <span class='@vertical ivar id'>@vertical</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="wrapText=-instance_method"></span> + <span id="wrapText-instance_method"></span> + <div class="method_details "> + <p class="signature " id="wrapText-instance_method"> + + - (<tt>Boolean</tt>) <strong>wrapText</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Indicate if the text of the cell should wrap +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +37 +38 +39</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 37</span> + +<span class='def def kw'>def</span> <span class='wrapText identifier id'>wrapText</span> + <span class='@wrapText ivar id'>@wrapText</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 cell alignment +</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"> + + +91 +92 +93</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 91</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='alignment identifier id'>alignment</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:44:02 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/CellProtection.html b/doc/Axlsx/CellProtection.html new file mode 100644 index 00000000..345e3e09 --- /dev/null +++ b/doc/Axlsx/CellProtection.html @@ -0,0 +1,565 @@ +<!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::CellProtection + + — 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 (C)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">CellProtection</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::CellProtection + + + +</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::CellProtection</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/stylesheet/cell_protection.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> +Using Styles#add_style is the recommended way to manage cell protection. +</p> +</div> + </div> + +<p> +CellProtection stores information about locking or hiding cells in +spreadsheet. +</p> + + + </div> +</div> +<div class="tags"> + + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="Styles.html#add_style-instance_method" title="Axlsx::Styles#add_style (method)">Styles#add_style</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="#hidden-instance_method" title="#hidden (instance method)">- (Boolean) <strong>hidden</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +specifies locking for cells that have the style containing this protection. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#locked-instance_method" title="#locked (instance method)">- (Boolean) <strong>locked</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +specifies if the cells that have the style containing this protection. +</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)">- (CellProtection) <strong>initialize</strong>(options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new CellProtection. +</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 cell protection. +</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::CellProtection (class)">CellProtection</a></span></tt>) <strong>initialize</strong>(options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new CellProtection +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <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">hidden</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + — <div class='inline'><p> +value for hidden protection +</p> +</div> + </li> + + <li> + <span class="name">locked</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + — <div class='inline'><p> +value for locked protection +</p> +</div> + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +18 +19 +20 +21 +22</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_protection.rb', line 18</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='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="hidden=-instance_method"></span> + <span id="hidden-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="hidden-instance_method"> + + - (<tt>Boolean</tt>) <strong>hidden</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +specifies locking for cells that have the style containing this protection +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +9 +10 +11</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_protection.rb', line 9</span> + +<span class='def def kw'>def</span> <span class='hidden identifier id'>hidden</span> + <span class='@hidden ivar id'>@hidden</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="locked=-instance_method"></span> + <span id="locked-instance_method"></span> + <div class="method_details "> + <p class="signature " id="locked-instance_method"> + + - (<tt>Boolean</tt>) <strong>locked</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +specifies if the cells that have the style containing this protection +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</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/stylesheet/cell_protection.rb', line 13</span> + +<span class='def def kw'>def</span> <span class='locked identifier id'>locked</span> + <span class='@locked ivar id'>@locked</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 cell protection +</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"> + + +29 +30 +31</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_protection.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='xml identifier id'>xml</span><span class='dot token'>.</span><span class='protection identifier id'>protection</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:44:06 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/CellStyle.html b/doc/Axlsx/CellStyle.html new file mode 100644 index 00000000..042069c9 --- /dev/null +++ b/doc/Axlsx/CellStyle.html @@ -0,0 +1,949 @@ +<!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::CellStyle + + — 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 (C)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">CellStyle</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::CellStyle + + + +</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::CellStyle</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/stylesheet/cell_style.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> +Using Styles#add_style is the recommended way to manage cell styling. +</p> +</div> + </div> + +<p> +CellStyle defines named styles that reference defined formatting records +and can be used in your worksheet. +</p> + + + </div> +</div> +<div class="tags"> + + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="Styles.html#add_style-instance_method" title="Axlsx::Styles#add_style (method)">Styles#add_style</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="#builtinId-instance_method" title="#builtinId (instance method)">- (Integer) <strong>builtinId</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The buildinId to use when this named style is applied. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#customBuiltin-instance_method" title="#customBuiltin (instance method)">- (Boolean) <strong>customBuiltin</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Indicates that the build in style reference has been customized. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#hidden-instance_method" title="#hidden (instance method)">- (Boolean) <strong>hidden</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Determines if this named style should show in the list of styles when using +excel. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#iLevel-instance_method" title="#iLevel (instance method)">- (Integer) <strong>iLevel</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Determines if this formatting is for an outline style, and what level of +the outline it is to be applied to. +</p> +</div></span> + +</li> + + + <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 of this cell style. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#xfId-instance_method" title="#xfId (instance method)">- (Integer) <strong>xfId</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The formatting record id this named style utilizes. +</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)">- (CellStyle) <strong>initialize</strong>(options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creats a new CellStyle object. +</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 cell style. +</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::CellStyle (class)">CellStyle</a></span></tt>) <strong>initialize</strong>(options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creats a new CellStyle object +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <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">xfId</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">buildinId</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">iLevel</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">hidden</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">customBuiltIn</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +39 +40 +41 +42 +43</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_style.rb', line 39</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='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="builtinId=-instance_method"></span> + <span id="builtinId-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="builtinId-instance_method"> + + - (<tt>Integer</tt>) <strong>builtinId</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The buildinId to use when this named style is applied +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + </li> + +</ul> + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="NumFmt.html" title="Axlsx::NumFmt (class)">NumFmt</a></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/stylesheet/cell_style.rb', line 18</span> + +<span class='def def kw'>def</span> <span class='builtinId identifier id'>builtinId</span> + <span class='@builtinId ivar id'>@builtinId</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="customBuiltin=-instance_method"></span> + <span id="customBuiltin-instance_method"></span> + <div class="method_details "> + <p class="signature " id="customBuiltin-instance_method"> + + - (<tt>Boolean</tt>) <strong>customBuiltin</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Indicates that the build in style reference has been customized. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +30 +31 +32</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_style.rb', line 30</span> + +<span class='def def kw'>def</span> <span class='customBuiltin identifier id'>customBuiltin</span> + <span class='@customBuiltin ivar id'>@customBuiltin</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="hidden=-instance_method"></span> + <span id="hidden-instance_method"></span> + <div class="method_details "> + <p class="signature " id="hidden-instance_method"> + + - (<tt>Boolean</tt>) <strong>hidden</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Determines if this named style should show in the list of styles when using +excel +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +26 +27 +28</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_style.rb', line 26</span> + +<span class='def def kw'>def</span> <span class='hidden identifier id'>hidden</span> + <span class='@hidden ivar id'>@hidden</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="iLevel=-instance_method"></span> + <span id="iLevel-instance_method"></span> + <div class="method_details "> + <p class="signature " id="iLevel-instance_method"> + + - (<tt>Integer</tt>) <strong>iLevel</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Determines if this formatting is for an outline style, and what level of +the outline it is to be applied to. +</p> + + + </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/stylesheet/cell_style.rb', line 22</span> + +<span class='def def kw'>def</span> <span class='iLevel identifier id'>iLevel</span> + <span class='@iLevel ivar id'>@iLevel</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 of this cell style +</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"> + + +8 +9 +10</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_style.rb', line 8</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="xfId=-instance_method"></span> + <span id="xfId-instance_method"></span> + <div class="method_details "> + <p class="signature " id="xfId-instance_method"> + + - (<tt>Integer</tt>) <strong>xfId</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The formatting record id this named style utilizes +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + </li> + +</ul> + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="Xf.html" title="Axlsx::Xf (class)">Xf</a></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/stylesheet/cell_style.rb', line 13</span> + +<span class='def def kw'>def</span> <span class='xfId identifier id'>xfId</span> + <span class='@xfId ivar id'>@xfId</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 cell style +</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"> + + +55 +56 +57</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_style.rb', line 55</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='cellStyle identifier id'>cellStyle</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43: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> + + </body> +</html>
\ No newline at end of file diff --git a/doc/Axlsx/Chart.html b/doc/Axlsx/Chart.html new file mode 100644 index 00000000..ee2c89d7 --- /dev/null +++ b/doc/Axlsx/Chart.html @@ -0,0 +1,1369 @@ +<!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::Chart + + — 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 (C)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">Chart</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::Chart + + + +</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::Chart</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/drawing/chart.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> +Worksheet#add_chart is the recommended way to create charts for your +worksheets. +</p> +</div> + </div> + +<p> +A Chart is the superclass for specific charts +</p> + + + </div> +</div> +<div class="tags"> + + +</div><div id="subclasses"> + <h2>Direct Known Subclasses</h2> + <p class="children"><span class='object_link'><a href="Bar3DChart.html" title="Axlsx::Bar3DChart (class)">Bar3DChart</a></span>, <span class='object_link'><a href="Pie3DChart.html" title="Axlsx::Pie3DChart (class)">Pie3DChart</a></span></p> +</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="#end_at-instance_method" title="#end_at (instance method)">- (Marker) <strong>end_at</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The ending marker for this chart. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#graphic_frame-instance_method" title="#graphic_frame (instance method)">- (GraphicFrame) <strong>graphic_frame</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +A reference to the graphic frame that owns this chart. +</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 chart in the workbooks charts collection. +</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 chart. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#series-instance_method" title="#series (instance method)">- (SimpleTypedList) <strong>series</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +A collection of series objects that are applied to the chart. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#series_type-instance_method" title="#series_type (instance method)">- (Series) <strong>series_type</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The type of series to use for this chart. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#show_legend-instance_method" title="#show_legend (instance method)">- (Boolean) <strong>show_legend</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Show the legend in the chart. +</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> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The starting marker for this chart. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#title-instance_method" title="#title (instance method)">- (Title) <strong>title</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The title object for the chart. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#view3D-instance_method" title="#view3D (instance method)">- (Object) <strong>view3D</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The 3D view properties for the chart. +</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="#add_series-instance_method" title="#add_series (instance method)">- (Series) <strong>add_series</strong>(options = {}) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Adds a new series to the chart’s series collection. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#initialize-instance_method" title="#initialize (instance method)">- (Chart) <strong>initialize</strong>(frame, options = {}) {|_self| ... }</a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new chart object. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#to_xml-instance_method" title="#to_xml (instance method)">- (Object) <strong>to_xml</strong> </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Chart Serialization serializes the chart. +</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::Chart (class)">Chart</a></span></tt>) <strong>initialize</strong>(frame, options = {}) {|_self| ... } + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new chart object +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>frame</span> + + + <span class='type'>(<tt>GraphicalFrame</tt>)</span> + + + + — + <div class='inline'><p> +The frame that holds this chart. +</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">title</span> + <span class="type">(<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>, <tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">show_legend</span> + <span class="type">(<tt>Boolean</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::Chart (class)">Axlsx::Chart</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"> + + +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 52</span> + +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='frame identifier id'>frame</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='assign token'>=</span><span class='frame identifier id'>frame</span> + <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='dot token'>.</span><span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='worksheet identifier id'>worksheet</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='charts identifier id'>charts</span> <span class='lshft op'><<</span> <span class='self self kw'>self</span> + <span class='@series ivar id'>@series</span> <span class='assign token'>=</span> <span class='SimpleTypedList constant id'>SimpleTypedList</span><span class='dot token'>.</span><span class='new identifier id'>new</span> <span class='Series constant id'>Series</span> + <span class='@show_legend ivar id'>@show_legend</span> <span class='assign token'>=</span> <span class='true true kw'>true</span> + <span class='@series_type ivar id'>@series_type</span> <span class='assign token'>=</span> <span class='Series constant id'>Series</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> + <span class='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="end_at=-instance_method"></span> + <span id="end_at-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="end_at-instance_method"> + + - (<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>) <strong>end_at</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The ending marker for this chart +</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"> + + +42 +43 +44</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 42</span> + +<span class='def def kw'>def</span> <span class='end_at identifier id'>end_at</span> + <span class='@end_at ivar id'>@end_at</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="graphic_frame-instance_method"></span> + <div class="method_details "> + <p class="signature " id="graphic_frame-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> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +A reference to the graphic frame that owns this chart +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="GraphicFrame.html" title="Axlsx::GraphicFrame (class)">GraphicFrame</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +15 +16 +17</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 15</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='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 chart in the workbooks charts collection +</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"> + + +27 +28 +29</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 27</span> + +<span class='def def kw'>def</span> <span class='index identifier id'>index</span> + <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='dot token'>.</span><span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='worksheet identifier id'>worksheet</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='charts identifier id'>charts</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 chart +</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"> + + +31 +32 +33</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 31</span> + +<span class='def def kw'>def</span> <span class='pn identifier id'>pn</span> + <span class='dstring node'>"#{CHART_PN % (index+1)}"</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="series-instance_method"></span> + <div class="method_details "> + <p class="signature " id="series-instance_method"> + + - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>series</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +A collection of series objects that are applied to the chart +</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> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +19 +20 +21</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 19</span> + +<span class='def def kw'>def</span> <span class='series identifier id'>series</span> + <span class='@series ivar id'>@series</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="series_type-instance_method"></span> + <div class="method_details "> + <p class="signature " id="series_type-instance_method"> + + - (<tt><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></tt>) <strong>series_type</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The type of series to use for this chart +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></tt>)</span> + + + + </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/chart.rb', line 23</span> + +<span class='def def kw'>def</span> <span class='series_type identifier id'>series_type</span> + <span class='@series_type ivar id'>@series_type</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="show_legend=-instance_method"></span> + <span id="show_legend-instance_method"></span> + <div class="method_details "> + <p class="signature " id="show_legend-instance_method"> + + - (<tt>Boolean</tt>) <strong>show_legend</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Show the legend in the chart +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +46 +47 +48</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 46</span> + +<span class='def def kw'>def</span> <span class='show_legend identifier id'>show_legend</span> + <span class='@show_legend ivar id'>@show_legend</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="start_at=-instance_method"></span> + <span id="start_at-instance_method"></span> + <div class="method_details "> + <p class="signature " 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> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The starting marker for this chart +</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"> + + +38 +39 +40</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 38</span> + +<span class='def def kw'>def</span> <span class='start_at identifier id'>start_at</span> + <span class='@start_at ivar id'>@start_at</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="title=-instance_method"></span> + <span id="title-instance_method"></span> + <div class="method_details "> + <p class="signature " id="title-instance_method"> + + - (<tt><span class='object_link'><a href="Title.html" title="Axlsx::Title (class)">Title</a></span></tt>) <strong>title</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The title object for the chart. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Title.html" title="Axlsx::Title (class)">Title</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +8 +9 +10</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 8</span> + +<span class='def def kw'>def</span> <span class='title identifier id'>title</span> + <span class='@title ivar id'>@title</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="view3D=-instance_method"></span> + <span id="view3D-instance_method"></span> + <div class="method_details "> + <p class="signature " id="view3D-instance_method"> + + - (<tt>Object</tt>) <strong>view3D</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The 3D view properties for the chart +</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +11 +12 +13</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 11</span> + +<span class='def def kw'>def</span> <span class='view3D identifier id'>view3D</span> + <span class='@view3D ivar id'>@view3D</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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="add_series-instance_method"> + + - (<tt><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></tt>) <strong>add_series</strong>(options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Adds a new series to the chart’s series collection. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></tt>)</span> + + + + </li> + +</ul> + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +85 +86 +87 +88</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 85</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> + <span class='@series ivar id'>@series</span><span class='dot token'>.</span><span class='last identifier id'>last</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="to_xml-instance_method"> + + - (<tt>Object</tt>) <strong>to_xml</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Chart Serialization serializes the chart +</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +92 +93 +94 +95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 92</span> + +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span> + <span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:chartSpace'</span><span class='comma token'>,</span><span class='symbol val'>:'xmlns:c'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS_C constant id'>XML_NS_C</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:a'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS_A constant id'>XML_NS_A</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:chart'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='@title ivar id'>@title</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@title ivar id'>@title</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='@view3D ivar id'>@view3D</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@view3D ivar id'>@view3D</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:plotArea'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:layout'</span><span class='rparen token'>)</span> + <span class='yield yield kw'>yield</span> <span class='xml identifier id'>xml</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> + <span class='rbrace token'>}</span> + <span class='if if kw'>if</span> <span class='@show_legend ivar id'>@show_legend</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:legend'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:legendPos'</span><span class='comma token'>,</span> <span class='symbol val'>:val</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"r"</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:layout'</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:44:01 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/Color.html b/doc/Axlsx/Color.html new file mode 100644 index 00000000..f73dc256 --- /dev/null +++ b/doc/Axlsx/Color.html @@ -0,0 +1,665 @@ +<!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::Color + + — 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 (C)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">Color</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::Color + + + +</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::Color</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/stylesheet/color.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +The color class represents a color used for borders, fills an fonts +</p> + + + </div> +</div> +<div class="tags"> + + +</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="#auto-instance_method" title="#auto (instance method)">- (Boolean) <strong>auto</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Determines if the color is system color dependant. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#rgb-instance_method" title="#rgb (instance method)">- (String) <strong>rgb</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The color as defined in rgb terms. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#tint-instance_method" title="#tint (instance method)">- (Float) <strong>tint</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The tint value. +</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)">- (Color) <strong>initialize</strong>(options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new Color object. +</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 color. +</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::Color (class)">Color</a></span></tt>) <strong>initialize</strong>(options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new Color object +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <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">auto</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">rgb</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">tint</span> + <span class="type">(<tt>Float</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +34 +35 +36 +37 +38 +39</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/color.rb', line 34</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='@rgb ivar id'>@rgb</span> <span class='assign token'>=</span> <span class='string val'>"FF000000"</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="auto=-instance_method"></span> + <span id="auto-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="auto-instance_method"> + + - (<tt>Boolean</tt>) <strong>auto</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Determines if the color is system color dependant +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +6 +7 +8</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/color.rb', line 6</span> + +<span class='def def kw'>def</span> <span class='auto identifier id'>auto</span> + <span class='@auto ivar id'>@auto</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="rgb=-instance_method"></span> + <span id="rgb-instance_method"></span> + <div class="method_details "> + <p class="signature " id="rgb-instance_method"> + + - (<tt>String</tt>) <strong>rgb</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +rgb colors need to conform to ST_UnsignedIntHex. That basically means put +‘FF’ before you color +</p> +</div> + </div> + +<p> +The color as defined in rgb terms. +</p> + + + </div> +</div> +<div class="tags"> + + <div class="examples"> + <h3>Examples:</h3> + + <h4><div class='inline'><p> +rgb colors +</p> +</div></h4> + <pre class="example code"><span class='string val'>"FF000000"</span> <span class='is identifier id'>is</span> <span class='black identifier id'>black</span> +<span class='string val'>"FFFFFFFF"</span> <span class='is identifier id'>is</span> <span class='white identifier id'>white</span> +</pre> + + </div> + +<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"> + + +19 +20 +21</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/color.rb', line 19</span> + +<span class='def def kw'>def</span> <span class='rgb identifier id'>rgb</span> + <span class='@rgb ivar id'>@rgb</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="tint=-instance_method"></span> + <span id="tint-instance_method"></span> + <div class="method_details "> + <p class="signature " id="tint-instance_method"> + + - (<tt>Float</tt>) <strong>tint</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +valid values are between -1.0 and 1.0 +</p> +</div> + </div> + +<p> +The tint value. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Float</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +28 +29 +30</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/color.rb', line 28</span> + +<span class='def def kw'>def</span> <span class='tint identifier id'>tint</span> + <span class='@tint ivar id'>@tint</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 color +</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"> + + +55</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/color.rb', line 55</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='color identifier id'>color</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='rparen token'>)</span> <span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43:54 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/ContentType.html b/doc/Axlsx/ContentType.html new file mode 100644 index 00000000..ab1ccff9 --- /dev/null +++ b/doc/Axlsx/ContentType.html @@ -0,0 +1,340 @@ +<!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::ContentType + + — 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 (C)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">ContentType</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::ContentType + + + +</h1> + +<dl class="box"> + + <dt class="r1">Inherits:</dt> + <dd class="r1"> + <span class="inheritName"><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></span> + + <ul class="fullTree"> + <li>Object</li> + + <li class="next"><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></li> + + <li class="next">Axlsx::ContentType</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/content_type/content_type.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +ContentTypes used in the package. This is automatcially managed by the +package package. +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + + + + + + + + + + + <h2>Instance Attribute Summary</h2> + + <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></h3> + <p class="inherited"><span class='object_link'><a href="SimpleTypedList.html#allowed_types-instance_method" title="Axlsx::SimpleTypedList#allowed_types (method)">allowed_types</a></span>, <span class='object_link'><a href="SimpleTypedList.html#locked_at-instance_method" title="Axlsx::SimpleTypedList#locked_at (method)">locked_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#serialize_as-instance_method" title="Axlsx::SimpleTypedList#serialize_as (method)">serialize_as</a></span></p> + + + + <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)">- (ContentType) <strong>initialize</strong> </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +A new instance of ContentType. +</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> </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Generates the xml document for [Content_Types].xml. +</p> +</div></span> + +</li> + + + </ul> + + + + + + + + + + + <h3 class="inherited">Methods inherited from <span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></h3> + <p class="inherited"><span class='object_link'><a href="SimpleTypedList.html#%3C%3C-instance_method" title="Axlsx::SimpleTypedList#<< (method)">#<<</a></span>, <span class='object_link'><a href="SimpleTypedList.html#%5B%5D%3D-instance_method" title="Axlsx::SimpleTypedList#[]= (method)">#[]=</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete-instance_method" title="Axlsx::SimpleTypedList#delete (method)">#delete</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete_at-instance_method" title="Axlsx::SimpleTypedList#delete_at (method)">#delete_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#lock-instance_method" title="Axlsx::SimpleTypedList#lock (method)">#lock</a></span>, <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">#method_missing</a></span>, <span class='object_link'><a href="SimpleTypedList.html#protected%3F-instance_method" title="Axlsx::SimpleTypedList#protected? (method)">#protected?</a></span>, <span class='object_link'><a href="SimpleTypedList.html#push-instance_method" title="Axlsx::SimpleTypedList#push (method)">#push</a></span>, <span class='object_link'><a href="SimpleTypedList.html#unlock-instance_method" title="Axlsx::SimpleTypedList#unlock (method)">#unlock</a></span></p> +<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::ContentType (class)">ContentType</a></span></tt>) <strong>initialize</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +A new instance of ContentType +</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +8 +9 +10</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/content_type.rb', line 8</span> + +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span> + <span class='super super kw'>super</span> <span class='lbrack token'>[</span><span class='Override constant id'>Override</span><span class='comma token'>,</span> <span class='Default constant id'>Default</span><span class='rbrack token'>]</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> +<div id="method_missing_details" class="method_details_list"> + <h2>Dynamic Method Handling</h2> + <p class="notice super"> + This class handles dynamic methods through the <tt>method_missing</tt> method + + in the class <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">Axlsx::SimpleTypedList</a></span> + + </p> + +</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> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Generates the xml document for [Content_Types].xml +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +The document as a string. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +14 +15 +16 +17 +18 +19 +20 +21</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/content_type.rb', line 14</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='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='Types constant id'>Types</span><span class='lparen token'>(</span><span class='symbol val'>:xmlns</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='XML_NS_T constant id'>XML_NS_T</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='type identifier id'>type</span><span class='bitor op'>|</span> <span class='type identifier id'>type</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43:53 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/Core.html b/doc/Axlsx/Core.html new file mode 100644 index 00000000..ab5ae902 --- /dev/null +++ b/doc/Axlsx/Core.html @@ -0,0 +1,465 @@ +<!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::Core + + — 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 (C)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">Core</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::Core + + + +</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::Core</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/doc_props/core.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> +Packages manage their own core object. +</p> +</div> + </div> + +<p> +The core object for the package. +</p> + + + </div> +</div> +<div class="tags"> + + + <h3>See Also:</h3> + <ul class="see"> + + <li>Package#core</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="#creator-instance_method" title="#creator (instance method)">- (String) <strong>creator</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The author of the document. +</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)">- (Core) <strong>initialize</strong>(options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new Core object. +</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> </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Serializes the core object. +</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::Core (class)">Core</a></span></tt>) <strong>initialize</strong>(options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new Core object. +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <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">creator</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +12 +13 +14</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/core.rb', line 12</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='@creator ivar id'>@creator</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:creator</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='string val'>'axlsx'</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="creator=-instance_method"></span> + <span id="creator-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="creator-instance_method"> + + - (<tt>String</tt>) <strong>creator</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The author of the document. By default this is ‘axlsx’ +</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"> + + +8 +9 +10</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/core.rb', line 8</span> + +<span class='def def kw'>def</span> <span class='creator identifier id'>creator</span> + <span class='@creator ivar id'>@creator</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Serializes the core object. The created dcterms item is set to the current +time when this method is called. +</p> + + + </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"> + + +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/core.rb', line 18</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='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'cp:coreProperties'</span><span class='comma token'>,</span> + <span class='symbol val'>:"xmlns:cp"</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='CORE_NS constant id'>CORE_NS</span><span class='comma token'>,</span> + <span class='symbol val'>:'xmlns:dc'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='CORE_NS_DC constant id'>CORE_NS_DC</span><span class='comma token'>,</span> + <span class='symbol val'>:'xmlns:dcmitype'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='CORE_NS_DCMIT constant id'>CORE_NS_DCMIT</span><span class='comma token'>,</span> + <span class='symbol val'>:'xmlns:dcterms'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='CORE_NS_DCT constant id'>CORE_NS_DCT</span><span class='comma token'>,</span> + <span class='symbol val'>:'xmlns:xsi'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='CORE_NS_XSI constant id'>CORE_NS_XSI</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='lbrack token'>[</span><span class='string val'>'dc'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='creator identifier id'>creator</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='creator identifier id'>creator</span> + <span class='xml identifier id'>xml</span><span class='lbrack token'>[</span><span class='string val'>'dcterms'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='created identifier id'>created</span> <span class='Time constant id'>Time</span><span class='dot token'>.</span><span class='now identifier id'>now</span><span class='dot token'>.</span><span class='strftime identifier id'>strftime</span><span class='lparen token'>(</span><span class='string val'>'%Y-%m-%dT%H:%M:%S'</span><span class='rparen token'>)</span><span class='comma token'>,</span> <span class='symbol val'>:'xsi:type'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='string val'>"dcterms:W3CDTF"</span> + <span class='xml identifier id'>xml</span><span class='lbrack token'>[</span><span class='string val'>'cp'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='revision identifier id'>revision</span> <span class='integer val'>0</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43:57 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/DataTypeValidator.html b/doc/Axlsx/DataTypeValidator.html new file mode 100644 index 00000000..2dc7891f --- /dev/null +++ b/doc/Axlsx/DataTypeValidator.html @@ -0,0 +1,324 @@ +<!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::DataTypeValidator + + — 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 (D)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">DataTypeValidator</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::DataTypeValidator + + + +</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::DataTypeValidator</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/util/validators.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +Validate that the class of the value provided is either an instance or the +class of the allowed types and that any specified additional validation +returns true. +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + + + + + + <h2> + Class Method Summary + <small>(<a href="#" class="summary_toggle">collapse</a>)</small> + </h2> + + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> + + <a href="#validate-class_method" title="validate (class method)">+ (Boolean) <strong>validate</strong>(name, types, v, other = lambda{|v| true }) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Perform validation. +</p> +</div></span> + +</li> + + + </ul> + + + + + <div id="class_method_details" class="method_details_list"> + <h2>Class Method Details</h2> + + + <div class="method_details first"> + <p class="signature first" id="validate-class_method"> + + + (<tt>Boolean</tt>) <strong>validate</strong>(name, types, v, other = lambda{|v| true }) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Perform validation +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>name</span> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +The name of what is being validated. This is included in the error message +</p> +</div> + + </li> + + <li> + + <span class='name'>types</span> + + + <span class='type'>(<tt>Array</tt>, <tt>Class</tt>)</span> + + + + — + <div class='inline'><p> +A single class or array of classes that the value is validated against. +</p> +</div> + + </li> + + <li> + + <span class='name'>other</span> + + + <span class='type'>(<tt>Block</tt>)</span> + + + <em class="default">(defaults to: <tt>lambda{|v| true }</tt>)</em> + + + — + <div class='inline'><p> +Any block that must evaluate to true for the value to be valid +</p> +</div> + + </li> + +</ul> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + — + <div class='inline'><p> +true if validation succeeds. +</p> +</div> + + </li> + +</ul> +<h3>Raises:</h3> +<ul class="raise"> + + <li> + + + <span class='type'>(<tt>ArugumentError</tt>)</span> + + + + — + <div class='inline'><p> +Raised if the class of the value provided is not in the specified array of +types or the block passed returns false +</p> +</div> + + </li> + +</ul> + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="../Axlsx.html#validate_boolean-class_method" title="Axlsx.validate_boolean (method)">Axlsx.validate_boolean</a></span></li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +34 +35 +36 +37 +38 +39 +40 +41 +42 +43</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 34</span> + +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='types identifier id'>types</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='comma token'>,</span> <span class='other identifier id'>other</span><span class='assign token'>=</span> <span class='lambda identifier id'>lambda</span><span class='lbrace token'>{</span><span class='bitor op'>|</span><span class='v identifier id'>v</span><span class='bitor op'>|</span> <span class='true true kw'>true</span> <span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='types identifier id'>types</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='types identifier id'>types</span><span class='rbrack token'>]</span> <span class='unless unless_mod kw'>unless</span> <span class='types identifier id'>types</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span> <span class='Array constant id'>Array</span> + <span class='valid_type identifier id'>valid_type</span> <span class='assign token'>=</span> <span class='false false kw'>false</span> + <span class='if if kw'>if</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='class identifier id'>class</span> <span class='eq op'>==</span> <span class='Class constant id'>Class</span> + <span class='types identifier id'>types</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='t identifier id'>t</span><span class='bitor op'>|</span> <span class='valid_type identifier id'>valid_type</span> <span class='assign token'>=</span> <span class='true true kw'>true</span> <span class='if if_mod kw'>if</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='ancestors identifier id'>ancestors</span><span class='dot token'>.</span><span class='include? fid id'>include?</span><span class='lparen token'>(</span><span class='t identifier id'>t</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> + <span class='else else kw'>else</span> + <span class='types identifier id'>types</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='t identifier id'>t</span><span class='bitor op'>|</span> <span class='valid_type identifier id'>valid_type</span> <span class='assign token'>=</span> <span class='true true kw'>true</span> <span class='if if_mod kw'>if</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='t identifier id'>t</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='lparen token'>(</span><span class='ERR_TYPE constant id'>ERR_TYPE</span> <span class='mod op'>%</span> <span class='lbrack token'>[</span><span class='v identifier id'>v</span><span class='dot token'>.</span><span class='inspect identifier id'>inspect</span><span class='comma token'>,</span> <span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='types identifier id'>types</span><span class='dot token'>.</span><span class='inspect identifier id'>inspect</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='lparen token'>(</span><span class='other identifier id'>other</span><span class='dot token'>.</span><span class='call identifier id'>call</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> <span class='andop op'>&&</span> <span class='valid_type identifier id'>valid_type</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43: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> + + </body> +</html>
\ No newline at end of file diff --git a/doc/Axlsx/Default.html b/doc/Axlsx/Default.html new file mode 100644 index 00000000..9294ab8f --- /dev/null +++ b/doc/Axlsx/Default.html @@ -0,0 +1,575 @@ +<!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::Default + + — 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 (D)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">Default</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::Default + + + +</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::Default</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/content_type/default.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +An default content part. These parts are automatically created by for you +based on the content of your package. +</p> + + + </div> +</div> +<div class="tags"> + + +</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="#ContentType-instance_method" title="#ContentType (instance method)">- (String) <strong>ContentType</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +ContentType The type of content. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#Extension-instance_method" title="#Extension (instance method)">- (String) <strong>Extension</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The extension of the content type. +</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)">- (Default) <strong>initialize</strong>(options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new Default object. +</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 object to xml. +</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::Default (class)">Default</a></span></tt>) <strong>initialize</strong>(options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new Default object +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <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">Extension</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">ContentType</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + +<h3>Raises:</h3> +<ul class="raise"> + + <li> + + + <span class='type'>(<tt>ArgumentError</tt>)</span> + + + + — + <div class='inline'><p> +An argument error is raised if both Extension and ContentType are not +specified. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +16 +17 +18 +19 +20 +21</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/default.rb', line 16</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='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='string val'>"Extension and ContentType are required"</span> <span class='unless unless_mod kw'>unless</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:Extension</span><span class='rbrack token'>]</span> <span class='andop op'>&&</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:ContentType</span><span class='rbrack token'>]</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="ContentType=-instance_method"></span> + <span id="ContentType-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="ContentType-instance_method"> + + - (<tt>String</tt>) <strong>ContentType</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +ContentType The type of content. TABLE_CT, WORKBOOK_CT, APP_CT, RELS_CT, +STYLES_CT, XML_CT, WORKSHEET_CT, SHARED_STRINGS_CT, CORE_CT, CHART_CT, +DRAWING_CT are allowed +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +ContentType The type of content. TABLE_CT, WORKBOOK_CT, APP_CT, RELS_CT, +STYLES_CT, XML_CT, WORKSHEET_CT, SHARED_STRINGS_CT, CORE_CT, CHART_CT, +DRAWING_CT are allowed +</p> +</div> + + </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/content_type/default.rb', line 10</span> + +<span class='def def kw'>def</span> <span class='ContentType constant id'>ContentType</span> + <span class='@ContentType ivar id'>@ContentType</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="Extension=-instance_method"></span> + <span id="Extension-instance_method"></span> + <div class="method_details "> + <p class="signature " id="Extension-instance_method"> + + - (<tt>String</tt>) <strong>Extension</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The extension of the content type. +</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"> + + +7 +8 +9</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/default.rb', line 7</span> + +<span class='def def kw'>def</span> <span class='Extension constant id'>Extension</span> + <span class='@Extension ivar id'>@Extension</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 object to xml +</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"> + + +28 +29 +30</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/default.rb', line 28</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='Default constant id'>Default</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:44:06 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/Drawing.html b/doc/Axlsx/Drawing.html new file mode 100644 index 00000000..bcaa7592 --- /dev/null +++ b/doc/Axlsx/Drawing.html @@ -0,0 +1,1154 @@ +<!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::Drawing + + — 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 (D)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">Drawing</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::Drawing + + + +</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::Drawing</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/drawing/drawing.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 is to use the Worksheet.add_chart +method, specifying the chart class, start and end marker locations. +</p> +</div> + </div> + +<p> +A Drawing is a canvas for charts. Each worksheet has a single drawing that +can specify multiple anchors which reference charts. +</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="TwoCellAnchor.html" title="Axlsx::TwoCellAnchor (class)">TwoCellAnchor</a></span></li> + + <li><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</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="#anchors-instance_method" title="#anchors (instance method)">- (SimpleTypedList) <strong>anchors</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +A collection of anchors for this drawing. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#charts-instance_method" title="#charts (instance method)">- (Array) <strong>charts</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +An array of charts 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> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The index of this drawing in the owning workbooks’s drawings +collection. +</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 drawing. +</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> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The drawing’s relationships. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#rels_pn-instance_method" title="#rels_pn (instance method)">- (String) <strong>rels_pn</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The relational part name for this drawing. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#rId-instance_method" title="#rId (instance method)">- (String) <strong>rId</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The relation reference id for this drawing. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#worksheet-instance_method" title="#worksheet (instance method)">- (Worksheet) <strong>worksheet</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The worksheet that owns the drawing. +</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="#add_chart-instance_method" title="#add_chart (instance method)">- (Object) <strong>add_chart</strong>(chart_type, options = {}) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Adds a chart to the drawing. +</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> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new Drawing object. +</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> </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Serializes the drawing. +</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::Drawing (class)">Drawing</a></span></tt>) <strong>initialize</strong>(worksheet) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new Drawing object +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>worksheet</span> + + + <span class='type'>(<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>)</span> + + + + — + <div class='inline'><p> +The worksheet that owns this drawing +</p> +</div> + + </li> + +</ul> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +63 +64 +65 +66 +67 +68</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 63</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='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="anchors-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="anchors-instance_method"> + + - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>anchors</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +A collection of anchors for this drawing +</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> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +35 +36 +37</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 35</span> + +<span class='def def kw'>def</span> <span class='anchors identifier id'>anchors</span> + <span class='@anchors ivar id'>@anchors</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="charts-instance_method"></span> + <div class="method_details "> + <p class="signature " id="charts-instance_method"> + + - (<tt>Array</tt>) <strong>charts</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +An array of charts 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"> + + +39 +40 +41</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 39</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='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 drawing in the owning workbooks’s drawings +collection. +</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"> + + +43 +44 +45</pre> + </td> + <td> + <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='index identifier id'>index</span> + <span class='@worksheet ivar id'>@worksheet</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='drawings identifier id'>drawings</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 drawing +</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"> + + +51 +52 +53</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 51</span> + +<span class='def def kw'>def</span> <span class='pn identifier id'>pn</span> + <span class='dstring node'>"#{DRAWING_PN % (index+1)}"</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="relationships-instance_method"></span> + <div class="method_details "> + <p class="signature " id="relationships-instance_method"> + + - (<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>) <strong>relationships</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The drawing’s relationships. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +59 +60 +61 +62 +63 +64 +65 +66</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 59</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='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='r identifier id'>r</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="rels_pn-instance_method"></span> + <div class="method_details "> + <p class="signature " id="rels_pn-instance_method"> + + - (<tt>String</tt>) <strong>rels_pn</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The relational part name for this drawing +</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"> + + +55 +56 +57</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 55</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> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="rId-instance_method"></span> + <div class="method_details "> + <p class="signature " id="rId-instance_method"> + + - (<tt>String</tt>) <strong>rId</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The relation reference id for this drawing +</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"> + + +47 +48 +49</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 47</span> + +<span class='def def kw'>def</span> <span class='rId identifier id'>rId</span> + <span class='dstring node'>"rId#{index+1}"</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="worksheet-instance_method"></span> + <div class="method_details "> + <p class="signature " id="worksheet-instance_method"> + + - (<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>) <strong>worksheet</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The worksheet that owns the drawing +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +30 +31 +32</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 30</span> + +<span class='def def kw'>def</span> <span class='worksheet identifier id'>worksheet</span> + <span class='@worksheet ivar id'>@worksheet</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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="add_chart-instance_method"> + + - (<tt>Object</tt>) <strong>add_chart</strong>(chart_type, options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +The recommended way to manage charts is to use Worksheet.add_chart. +</p> +</div> + </div> + +<p> +Adds a chart to the drawing. +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>chart_type</span> + + + <span class='type'>(<tt><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></tt>)</span> + + + + — + <div class='inline'><p> +The class of the chart to be added to the drawing +</p> +</div> + + </li> + + <li> + + <span class='name'>options</span> + + + <span class='type'>(<tt>Hash</tt>)</span> + + + <em class="default">(defaults to: <tt>{}</tt>)</em> + + + </li> + +</ul> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +75 +76 +77 +78 +79</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 75</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='DataTypeValidator constant id'>DataTypeValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='string val'>"Drawing.chart_type"</span><span class='comma token'>,</span> <span class='Chart constant id'>Chart</span><span class='comma token'>,</span> <span class='chart_type identifier id'>chart_type</span> + <span class='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='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> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Serializes the drawing +</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"> + + +112 +113 +114 +115 +116 +117 +118 +119</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 112</span> + +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span> + <span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:wsDr'</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:xdr'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='XML_NS_XDR constant id'>XML_NS_XDR</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:a'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='XML_NS_A constant id'>XML_NS_A</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='anchors identifier id'>anchors</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span><span class='bitor op'>|</span><span class='anchor identifier id'>anchor</span><span class='bitor op'>|</span> <span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:44:03 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/Fill.html b/doc/Axlsx/Fill.html new file mode 100644 index 00000000..a88f3d0a --- /dev/null +++ b/doc/Axlsx/Fill.html @@ -0,0 +1,460 @@ +<!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::Fill + + — 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 (F)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">Fill</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::Fill + + + +</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::Fill</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/stylesheet/fill.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 styles in your workbook is to use +Styles#add_style. +</p> +</div> + </div> + +<p> +The Fill is a formatting object that manages the background color, and +pattern for cells. +</p> + + + </div> +</div> +<div class="tags"> + + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="Styles.html#add_style-instance_method" title="Axlsx::Styles#add_style (method)">Styles#add_style</a></span></li> + + <li><span class='object_link'><a href="PatternFill.html" title="Axlsx::PatternFill (class)">PatternFill</a></span></li> + + <li><span class='object_link'><a href="GradientFill.html" title="Axlsx::GradientFill (class)">GradientFill</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="#fill_type-instance_method" title="#fill_type (instance method)">- (PatternFill, GradientFill) <strong>fill_type</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The type of fill. +</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)">- (Fill) <strong>initialize</strong>(fill_type) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new Fill object. +</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 fill. +</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::Fill (class)">Fill</a></span></tt>) <strong>initialize</strong>(fill_type) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new Fill object +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>fill_type</span> + + + <span class='type'>(<tt><span class='object_link'><a href="PatternFill.html" title="Axlsx::PatternFill (class)">PatternFill</a></span></tt>, <tt><span class='object_link'><a href="GradientFill.html" title="Axlsx::GradientFill (class)">GradientFill</a></span></tt>)</span> + + + + </li> + +</ul> + +<h3>Raises:</h3> +<ul class="raise"> + + <li> + + + <span class='type'>(<tt>ArgumentError</tt>)</span> + + + + — + <div class='inline'><p> +if the fill_type parameter is not a PatternFill or a GradientFill instance +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +16 +17 +18</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/fill.rb', line 16</span> + +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='fill_type identifier id'>fill_type</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='fill_type identifier id'>fill_type</span> <span class='assign token'>=</span> <span class='fill_type identifier id'>fill_type</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="fill_type=-instance_method"></span> + <span id="fill_type-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="fill_type-instance_method"> + + - (<tt><span class='object_link'><a href="PatternFill.html" title="Axlsx::PatternFill (class)">PatternFill</a></span></tt>, <tt><span class='object_link'><a href="GradientFill.html" title="Axlsx::GradientFill (class)">GradientFill</a></span></tt>) <strong>fill_type</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The type of fill +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="PatternFill.html" title="Axlsx::PatternFill (class)">PatternFill</a></span></tt>, <tt><span class='object_link'><a href="GradientFill.html" title="Axlsx::GradientFill (class)">GradientFill</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +11 +12 +13</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/fill.rb', line 11</span> + +<span class='def def kw'>def</span> <span class='fill_type identifier id'>fill_type</span> + <span class='@fill_type ivar id'>@fill_type</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 fill +</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"> + + +23 +24 +25</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/fill.rb', line 23</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='fill identifier id'>fill</span> <span class='lbrace token'>{</span> <span class='@fill_type ivar id'>@fill_type</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43:59 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/Font.html b/doc/Axlsx/Font.html new file mode 100644 index 00000000..4f03d9dd --- /dev/null +++ b/doc/Axlsx/Font.html @@ -0,0 +1,1554 @@ +<!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::Font + + — 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 (F)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">Font</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::Font + + + +</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::Font</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/stylesheet/font.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 fonts, and other styles is Styles#add_style +</p> +</div> + </div> + +<p> +The Font class details a font instance for use in styling cells. +</p> + + + </div> +</div> +<div class="tags"> + + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="Styles.html#add_style-instance_method" title="Axlsx::Styles#add_style (method)">Styles#add_style</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="#b-instance_method" title="#b (instance method)">- (Boolean) <strong>b</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Indicates if the font should be rendered in <b>bold</b>. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#charset-instance_method" title="#charset (instance method)">- (Integer) <strong>charset</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The charset of the font. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#color-instance_method" title="#color (instance method)">- (Color) <strong>color</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The color of the font. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#condense-instance_method" title="#condense (instance method)">- (Boolean) <strong>condense</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Indicates if the font should be condensed. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#extend-instance_method" title="#extend (instance method)">- (Boolean) <strong>extend</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The font’s extend property. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#family-instance_method" title="#family (instance method)">- (Integer) <strong>family</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The font’s family. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#i-instance_method" title="#i (instance method)">- (Boolean) <strong>i</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Indicates if the font should be rendered italicized. +</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 of the font. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#outline-instance_method" title="#outline (instance method)">- (Boolean) <strong>outline</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Indicates if the font should be rendered with an outline. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#shadow-instance_method" title="#shadow (instance method)">- (Boolean) <strong>shadow</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Indicates if the font should be rendered with a shadow. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#strike-instance_method" title="#strike (instance method)">- (Boolean) <strong>strike</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Indicates if the font should be rendered with a strikthrough. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#sz-instance_method" title="#sz (instance method)">- (Integer) <strong>sz</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The size of the font. +</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)">- (Font) <strong>initialize</strong>(options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new Font. +</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 fill. +</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::Font (class)">Font</a></span></tt>) <strong>initialize</strong>(options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new Font +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <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">charset</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">family</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">family</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">b</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">i</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">strike</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">outline</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">shadow</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">condense</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">extend</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">color</span> + <span class="type">(<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">sz</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +98 +99 +100 +101 +102</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 98</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='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="b=-instance_method"></span> + <span id="b-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="b-instance_method"> + + - (<tt>Boolean</tt>) <strong>b</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Indicates if the font should be rendered in <b>bold</b> +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +50 +51 +52</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 50</span> + +<span class='def def kw'>def</span> <span class='b identifier id'>b</span> + <span class='@b ivar id'>@b</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="charset=-instance_method"></span> + <span id="charset-instance_method"></span> + <div class="method_details "> + <p class="signature " id="charset-instance_method"> + + - (<tt>Integer</tt>) <strong>charset</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +The following values are defined in the OOXML specification and are OS +dependant values +</p> +<pre class="code"> + <span class='integer val'>0</span> <span class='ANSI_CHARSET constant id'>ANSI_CHARSET</span> + <span class='integer val'>1</span> <span class='DEFAULT_CHARSET constant id'>DEFAULT_CHARSET</span> + <span class='integer val'>2</span> <span class='SYMBOL_CHARSET constant id'>SYMBOL_CHARSET</span> + <span class='integer val'>77</span> <span class='MAC_CHARSET constant id'>MAC_CHARSET</span> + <span class='integer val'>128</span> <span class='SHIFTJIS_CHARSET constant id'>SHIFTJIS_CHARSET</span> + <span class='integer val'>129</span> <span class='HANGUL_CHARSET constant id'>HANGUL_CHARSET</span> + <span class='integer val'>130</span> <span class='JOHAB_CHARSET constant id'>JOHAB_CHARSET</span> + <span class='integer val'>134</span> <span class='GB2312_CHARSET constant id'>GB2312_CHARSET</span> + <span class='integer val'>136</span> <span class='CHINESEBIG5_CHARSET constant id'>CHINESEBIG5_CHARSET</span> + <span class='integer val'>161</span> <span class='GREEK_CHARSET constant id'>GREEK_CHARSET</span> + <span class='integer val'>162</span> <span class='TURKISH_CHARSET constant id'>TURKISH_CHARSET</span> + <span class='integer val'>163</span> <span class='VIETNAMESE_CHARSET constant id'>VIETNAMESE_CHARSET</span> + <span class='integer val'>177</span> <span class='HEBREW_CHARSET constant id'>HEBREW_CHARSET</span> + <span class='integer val'>178</span> <span class='ARABIC_CHARSET constant id'>ARABIC_CHARSET</span> + <span class='integer val'>186</span> <span class='BALTIC_CHARSET constant id'>BALTIC_CHARSET</span> + <span class='integer val'>204</span> <span class='RUSSIAN_CHARSET constant id'>RUSSIAN_CHARSET</span> + <span class='integer val'>222</span> <span class='THAI_CHARSET constant id'>THAI_CHARSET</span> + <span class='integer val'>238</span> <span class='EASTEUROPE_CHARSET constant id'>EASTEUROPE_CHARSET</span> + <span class='integer val'>255</span> <span class='OEM_CHARSET constant id'>OEM_CHARSET</span> +</pre> +</div> + </div> + +<p> +The charset of the font +</p> + + + </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/stylesheet/font.rb', line 33</span> + +<span class='def def kw'>def</span> <span class='charset identifier id'>charset</span> + <span class='@charset ivar id'>@charset</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="color=-instance_method"></span> + <span id="color-instance_method"></span> + <div class="method_details "> + <p class="signature " id="color-instance_method"> + + - (<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>) <strong>color</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The color of the font +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +78 +79 +80</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 78</span> + +<span class='def def kw'>def</span> <span class='color identifier id'>color</span> + <span class='@color ivar id'>@color</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="condense=-instance_method"></span> + <span id="condense-instance_method"></span> + <div class="method_details "> + <p class="signature " id="condense-instance_method"> + + - (<tt>Boolean</tt>) <strong>condense</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Indicates if the font should be condensed +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +70 +71 +72</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 70</span> + +<span class='def def kw'>def</span> <span class='condense identifier id'>condense</span> + <span class='@condense ivar id'>@condense</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="extend=-instance_method"></span> + <span id="extend-instance_method"></span> + <div class="method_details "> + <p class="signature " id="extend-instance_method"> + + - (<tt>Boolean</tt>) <strong>extend</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The font’s extend property +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +74 +75 +76</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 74</span> + +<span class='def def kw'>def</span> <span class='extend identifier id'>extend</span> + <span class='@extend ivar id'>@extend</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="family=-instance_method"></span> + <span id="family-instance_method"></span> + <div class="method_details "> + <p class="signature " id="family-instance_method"> + + - (<tt>Integer</tt>) <strong>family</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +The following are defined OOXML specification +</p> +<pre class="code"> + <span class='integer val'>0</span> <span class='Not constant id'>Not</span> <span class='applicable identifier id'>applicable</span><span class='dot token'>.</span> + <span class='integer val'>1</span> <span class='Roman constant id'>Roman</span> + <span class='integer val'>2</span> <span class='Swiss constant id'>Swiss</span> + <span class='integer val'>3</span> <span class='Modern constant id'>Modern</span> + <span class='integer val'>4</span> <span class='Script constant id'>Script</span> + <span class='integer val'>5</span> <span class='Decorative constant id'>Decorative</span> + <span class='float val'>6</span><span class='dot2 op'>..</span><span class='integer val'>14</span> <span class='Reserved constant id'>Reserved</span> <span class='for for kw'>for</span> <span class='future identifier id'>future</span> <span class='use identifier id'>use</span> +</pre> +</div> + </div> + +<p> +The font’s family +</p> + + + </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"> + + +46 +47 +48</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 46</span> + +<span class='def def kw'>def</span> <span class='family identifier id'>family</span> + <span class='@family ivar id'>@family</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="i=-instance_method"></span> + <span id="i-instance_method"></span> + <div class="method_details "> + <p class="signature " id="i-instance_method"> + + - (<tt>Boolean</tt>) <strong>i</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Indicates if the font should be rendered italicized +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +54 +55 +56</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 54</span> + +<span class='def def kw'>def</span> <span class='i identifier id'>i</span> + <span class='@i ivar id'>@i</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 of the font +</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"> + + +8 +9 +10</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 8</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="outline=-instance_method"></span> + <span id="outline-instance_method"></span> + <div class="method_details "> + <p class="signature " id="outline-instance_method"> + + - (<tt>Boolean</tt>) <strong>outline</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Indicates if the font should be rendered with an outline +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +62 +63 +64</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 62</span> + +<span class='def def kw'>def</span> <span class='outline identifier id'>outline</span> + <span class='@outline ivar id'>@outline</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="shadow=-instance_method"></span> + <span id="shadow-instance_method"></span> + <div class="method_details "> + <p class="signature " id="shadow-instance_method"> + + - (<tt>Boolean</tt>) <strong>shadow</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Indicates if the font should be rendered with a shadow +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +66 +67 +68</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 66</span> + +<span class='def def kw'>def</span> <span class='shadow identifier id'>shadow</span> + <span class='@shadow ivar id'>@shadow</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="strike=-instance_method"></span> + <span id="strike-instance_method"></span> + <div class="method_details "> + <p class="signature " id="strike-instance_method"> + + - (<tt>Boolean</tt>) <strong>strike</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Indicates if the font should be rendered with a strikthrough +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +58 +59 +60</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 58</span> + +<span class='def def kw'>def</span> <span class='strike identifier id'>strike</span> + <span class='@strike ivar id'>@strike</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="sz=-instance_method"></span> + <span id="sz-instance_method"></span> + <div class="method_details "> + <p class="signature " id="sz-instance_method"> + + - (<tt>Integer</tt>) <strong>sz</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The size of the font. +</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"> + + +82 +83 +84</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 82</span> + +<span class='def def kw'>def</span> <span class='sz identifier id'>sz</span> + <span class='@sz ivar id'>@sz</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 fill +</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"> + + +120 +121 +122 +123 +124 +125 +126</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 120</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='font identifier id'>font</span> <span class='lbrace token'>{</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='k identifier id'>k</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='bitor op'>|</span> + <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Color constant id'>Color</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='colon op'>:</span> <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='k identifier id'>k</span><span class='comma token'>,</span> <span class='lbrace token'>{</span><span class='symbol val'>:val</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='v identifier id'>v</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43:54 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/GradientFill.html b/doc/Axlsx/GradientFill.html new file mode 100644 index 00000000..956af528 --- /dev/null +++ b/doc/Axlsx/GradientFill.html @@ -0,0 +1,1026 @@ +<!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::GradientFill + + — 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 (G)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">GradientFill</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::GradientFill + + + +</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::GradientFill</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/stylesheet/gradient_fill.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +A GradientFill defines the color and positioning for gradiant cell fill. +</p> + + + </div> +</div> +<div class="tags"> + + + <h3>See Also:</h3> + <ul class="see"> + + <li>Office XML Part 1 §18.8.24</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="#bottom-instance_method" title="#bottom (instance method)">- (Float) <strong>bottom</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Percentage format bottom. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#degree-instance_method" title="#degree (instance method)">- (Float) <strong>degree</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Angle of the linear gradient. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#left-instance_method" title="#left (instance method)">- (Float) <strong>left</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Percentage format left. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#right-instance_method" title="#right (instance method)">- (Float) <strong>right</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Percentage format right. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#stop-instance_method" title="#stop (instance method)">- (SimpleTypedList) <strong>stop</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Collection of stop objects. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#top-instance_method" title="#top (instance method)">- (Float) <strong>top</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Percentage format top. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#type-instance_method" title="#type (instance method)">- (Symbol) <strong>type</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The type of gradient. +</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)">- (GradientFill) <strong>initialize</strong>(options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new GradientFill object. +</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 gradientFill. +</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::GradientFill (class)">GradientFill</a></span></tt>) <strong>initialize</strong>(options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new GradientFill object +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <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">type</span> + <span class="type">(<tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">degree</span> + <span class="type">(<tt>Float</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">left</span> + <span class="type">(<tt>Float</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">right</span> + <span class="type">(<tt>Float</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">top</span> + <span class="type">(<tt>Float</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">bottom</span> + <span class="type">(<tt>Float</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +46 +47 +48 +49 +50 +51 +52</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 46</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='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:type</span><span class='rbrack token'>]</span> <span class='opasgn op'>||=</span> <span class='symbol val'>:linear</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> + <span class='@stop ivar id'>@stop</span> <span class='assign token'>=</span> <span class='SimpleTypedList constant id'>SimpleTypedList</span><span class='dot token'>.</span><span class='new identifier id'>new</span> <span class='GradientStop constant id'>GradientStop</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="bottom=-instance_method"></span> + <span id="bottom-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="bottom-instance_method"> + + - (<tt>Float</tt>) <strong>bottom</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Percentage format bottom +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Float</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +33 +34 +35</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 33</span> + +<span class='def def kw'>def</span> <span class='bottom identifier id'>bottom</span> + <span class='@bottom ivar id'>@bottom</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="degree=-instance_method"></span> + <span id="degree-instance_method"></span> + <div class="method_details "> + <p class="signature " id="degree-instance_method"> + + - (<tt>Float</tt>) <strong>degree</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Angle of the linear gradient +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Float</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +17 +18 +19</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 17</span> + +<span class='def def kw'>def</span> <span class='degree identifier id'>degree</span> + <span class='@degree ivar id'>@degree</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="left=-instance_method"></span> + <span id="left-instance_method"></span> + <div class="method_details "> + <p class="signature " id="left-instance_method"> + + - (<tt>Float</tt>) <strong>left</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Percentage format left +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Float</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +21 +22 +23</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 21</span> + +<span class='def def kw'>def</span> <span class='left identifier id'>left</span> + <span class='@left ivar id'>@left</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="right=-instance_method"></span> + <span id="right-instance_method"></span> + <div class="method_details "> + <p class="signature " id="right-instance_method"> + + - (<tt>Float</tt>) <strong>right</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Percentage format right +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Float</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +25 +26 +27</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 25</span> + +<span class='def def kw'>def</span> <span class='right identifier id'>right</span> + <span class='@right ivar id'>@right</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="stop-instance_method"></span> + <div class="method_details "> + <p class="signature " id="stop-instance_method"> + + - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>stop</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Collection of stop objects +</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> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +37 +38 +39</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 37</span> + +<span class='def def kw'>def</span> <span class='stop identifier id'>stop</span> + <span class='@stop ivar id'>@stop</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="top=-instance_method"></span> + <span id="top-instance_method"></span> + <div class="method_details "> + <p class="signature " id="top-instance_method"> + + - (<tt>Float</tt>) <strong>top</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Percentage format top +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Float</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +29 +30 +31</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 29</span> + +<span class='def def kw'>def</span> <span class='top identifier id'>top</span> + <span class='@top ivar id'>@top</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="type=-instance_method"></span> + <span id="type-instance_method"></span> + <div class="method_details "> + <p class="signature " id="type-instance_method"> + + - (<tt>Symbol</tt>) <strong>type</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +valid options are +</p> +<pre class="code"> + <span class='symbol val'>:linear</span> + <span class='symbol val'>:path</span> +</pre> +</div> + </div> + +<p> +The type of gradient. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Symbol</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/stylesheet/gradient_fill.rb', line 13</span> + +<span class='def def kw'>def</span> <span class='type identifier id'>type</span> + <span class='@type ivar id'>@type</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 gradientFill +</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"> + + +64 +65 +66 +67 +68</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 64</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='gradientFill identifier id'>gradientFill</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='dot token'>.</span><span class='reject identifier id'>reject</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='k identifier id'>k</span><span class='comma token'>,</span><span class='v identifier id'>v</span><span class='bitor op'>|</span> <span class='k identifier id'>k</span><span class='dot token'>.</span><span class='to_sym identifier id'>to_sym</span> <span class='eq op'>==</span> <span class='symbol val'>:stop</span> <span class='rbrace token'>}</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='@stop ivar id'>@stop</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='s identifier id'>s</span><span class='bitor op'>|</span> <span class='s identifier id'>s</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43:58 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/GradientStop.html b/doc/Axlsx/GradientStop.html new file mode 100644 index 00000000..eacf1c92 --- /dev/null +++ b/doc/Axlsx/GradientStop.html @@ -0,0 +1,526 @@ +<!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::GradientStop + + — 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 (G)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">GradientStop</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::GradientStop + + + +</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::GradientStop</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/stylesheet/gradient_stop.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +The GradientStop object represents a color point in a gradient. +</p> + + + </div> +</div> +<div class="tags"> + + + <h3>See Also:</h3> + <ul class="see"> + + <li>Office XML Part 1 §18.8.24</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="#color-instance_method" title="#color (instance method)">- (Color) <strong>color</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The color for this gradient stop. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#position-instance_method" title="#position (instance method)">- (Float) <strong>position</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The position of the color. +</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)">- (GradientStop) <strong>initialize</strong>(color, position) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new GradientStop object. +</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 gradientStop. +</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::GradientStop (class)">GradientStop</a></span></tt>) <strong>initialize</strong>(color, position) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new GradientStop object +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>color</span> + + + <span class='type'>(<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>)</span> + + + + </li> + + <li> + + <span class='name'>position</span> + + + <span class='type'>(<tt>Float</tt>)</span> + + + + </li> + +</ul> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +18 +19 +20 +21</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_stop.rb', line 18</span> + +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='color identifier id'>color</span><span class='comma token'>,</span> <span class='position identifier id'>position</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='color identifier id'>color</span> <span class='assign token'>=</span> <span class='color identifier id'>color</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='position identifier id'>position</span> <span class='assign token'>=</span> <span class='position identifier id'>position</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="color=-instance_method"></span> + <span id="color-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="color-instance_method"> + + - (<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>) <strong>color</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The color for this gradient stop +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>)</span> + + + + </li> + +</ul> + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +9 +10 +11</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_stop.rb', line 9</span> + +<span class='def def kw'>def</span> <span class='color identifier id'>color</span> + <span class='@color ivar id'>@color</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="position=-instance_method"></span> + <span id="position-instance_method"></span> + <div class="method_details "> + <p class="signature " id="position-instance_method"> + + - (<tt>Float</tt>) <strong>position</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The position of the color +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Float</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +13 +14 +15</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_stop.rb', line 13</span> + +<span class='def def kw'>def</span> <span class='position identifier id'>position</span> + <span class='@position ivar id'>@position</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 gradientStop +</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"> + + +29</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_stop.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='xml identifier id'>xml</span><span class='dot token'>.</span><span class='stop identifier id'>stop</span><span class='lparen token'>(</span><span class='symbol val'>:position</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='position identifier id'>position</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='color identifier id'>color</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span><span class='rbrace token'>}</span> <span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43: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> + + </body> +</html>
\ No newline at end of file diff --git a/doc/Axlsx/GraphicFrame.html b/doc/Axlsx/GraphicFrame.html new file mode 100644 index 00000000..490bc3df --- /dev/null +++ b/doc/Axlsx/GraphicFrame.html @@ -0,0 +1,646 @@ +<!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::GraphicFrame + + — 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 (G)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">GraphicFrame</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::GraphicFrame + + + +</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::GraphicFrame</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/drawing/graphic_frame.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 charts is Worksheet#add_chart +</p> +</div> + </div> + +<p> +A graphic frame defines a container for a chart object +</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> + + </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="#anchor-instance_method" title="#anchor (instance method)">- (TwoCellAnchor) <strong>anchor</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +A anchor that holds this frame. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#chart-instance_method" title="#chart (instance method)">- (Chart) <strong>chart</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +A reference to the chart object associated with this frame. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#rId-instance_method" title="#rId (instance method)">- (String) <strong>rId</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The relationship id for this graphic. +</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)">- (GraphicFrame) <strong>initialize</strong>(anchor, chart_type, options) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new GraphicFrame object. +</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 graphic frame. +</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::GraphicFrame (class)">GraphicFrame</a></span></tt>) <strong>initialize</strong>(anchor, chart_type, options) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new GraphicFrame object +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>anchor</span> + + + <span class='type'>(<tt><span class='object_link'><a href="TwoCellAnchor.html" title="Axlsx::TwoCellAnchor (class)">TwoCellAnchor</a></span></tt>)</span> + + + + </li> + + <li> + + <span class='name'>chart_type</span> + + + <span class='type'>(<tt>Class</tt>)</span> + + + + </li> + +</ul> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +24 +25 +26 +27</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 24</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='@anchor ivar id'>@anchor</span> <span class='assign token'>=</span> <span class='anchor identifier id'>anchor</span> + <span class='@chart ivar id'>@chart</span> <span class='assign token'>=</span> <span class='chart_type identifier id'>chart_type</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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="TwoCellAnchor.html" title="Axlsx::TwoCellAnchor (class)">TwoCellAnchor</a></span></tt>) <strong>anchor</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +A anchor that holds this frame +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="TwoCellAnchor.html" title="Axlsx::TwoCellAnchor (class)">TwoCellAnchor</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +15 +16 +17</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 15</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=""></span> + <span id="chart-instance_method"></span> + <div class="method_details "> + <p class="signature " id="chart-instance_method"> + + - (<tt><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></tt>) <strong>chart</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +A reference to the chart object associated with this frame +</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"> + + +11 +12 +13</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 11</span> + +<span class='def def kw'>def</span> <span class='chart identifier id'>chart</span> + <span class='@chart ivar id'>@chart</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="rId-instance_method"></span> + <div class="method_details "> + <p class="signature " id="rId-instance_method"> + + - (<tt>String</tt>) <strong>rId</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The relationship id for this graphic +</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"> + + +19 +20 +21</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 19</span> + +<span class='def def kw'>def</span> <span class='rId identifier id'>rId</span> + <span class='dstring node'>"rId#{@anchor.index+1}"</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 graphic frame +</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"> + + +36 +37 +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.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='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:graphicFrame'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:nvGraphicFramePr'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:cNvPr'</span><span class='comma token'>,</span> <span class='symbol val'>:id=</span><span class='gt op'>></span><span class='integer val'>2</span><span class='comma token'>,</span> <span class='symbol val'>:name=</span><span class='gt op'>></span><span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='title identifier id'>title</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:cNvGraphicFramePr'</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:xfrm'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'a:off'</span><span class='comma token'>,</span> <span class='symbol val'>:x=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='comma token'>,</span> <span class='symbol val'>:y=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'a:ext'</span><span class='comma token'>,</span> <span class='symbol val'>:cx=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='comma token'>,</span> <span class='symbol val'>:cy=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'a:graphic'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'a:graphicData'</span><span class='comma token'>,</span> <span class='symbol val'>:uri=</span><span class='gt op'>></span><span class='XML_NS_C constant id'>XML_NS_C</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:chart'</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:c'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='XML_NS_C constant id'>XML_NS_C</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:r'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='XML_NS_R constant id'>XML_NS_R</span><span class='comma token'>,</span> <span class='symbol val'>:'r:id'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='rId identifier id'>rId</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43: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/Marker.html b/doc/Axlsx/Marker.html new file mode 100644 index 00000000..4f22aea1 --- /dev/null +++ b/doc/Axlsx/Marker.html @@ -0,0 +1,857 @@ +<!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::Marker + + — 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 (M)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">Marker</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::Marker + + + +</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::Marker</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/drawing/marker.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 markers is Worksheet#add_chart Markers are +created for a two cell anchor based on the :start and :end options. +</p> +</div> + </div> + +<p> +The Marker class defines a point in the worksheet that drawing anchors +attach to. +</p> + + + </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> + + </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="#col-instance_method" title="#col (instance method)">- (Integer) <strong>col</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The column this marker anchors to. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#colOff-instance_method" title="#colOff (instance method)">- (Integer) <strong>colOff</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The offset distance from this marker’s column. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#row-instance_method" title="#row (instance method)">- (Integer) <strong>row</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The row this marker anchors to. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#rowOff-instance_method" title="#rowOff (instance method)">- (Integer) <strong>rowOff</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The offset distance from this marker’s row. +</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="#coord-instance_method" title="#coord (instance method)">- (Object) <strong>coord</strong>(col, row) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +shortcut to set the column, row position for this marker. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#initialize-instance_method" title="#initialize (instance method)">- (Marker) <strong>initialize</strong>(options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new Marker object. +</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 marker. +</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::Marker (class)">Marker</a></span></tt>) <strong>initialize</strong>(options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new Marker object +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>options</span> + + + <span class='type'>(<tt>Hash</tt>)</span> + + + <em class="default">(defaults to: <tt>{}</tt>)</em> + + + — + <div class='inline'><p> +a customizable set of options +</p> +</div> + + </li> + +</ul> + + + + + <h3>Options Hash (<tt>options</tt>):</h3> + <ul class="option"> + + <li> + <span class="name">col</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">colOff</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">row</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">rowOff</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +28 +29 +30 +31 +32 +33</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 28</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='@col ivar id'>@col</span><span class='comma token'>,</span> <span class='@colOff ivar id'>@colOff</span><span class='comma token'>,</span> <span class='@row ivar id'>@row</span><span class='comma token'>,</span> <span class='@rowOff ivar id'>@rowOff</span> <span class='assign token'>=</span> <span class='integer val'>0</span><span class='comma token'>,</span> <span class='integer val'>0</span><span class='comma token'>,</span> <span class='integer val'>0</span><span class='comma token'>,</span> <span class='integer val'>0</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="col=-instance_method"></span> + <span id="col-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="col-instance_method"> + + - (<tt>Integer</tt>) <strong>col</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The column this marker anchors to +</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"> + + +9 +10 +11</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 9</span> + +<span class='def def kw'>def</span> <span class='col identifier id'>col</span> + <span class='@col ivar id'>@col</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="colOff=-instance_method"></span> + <span id="colOff-instance_method"></span> + <div class="method_details "> + <p class="signature " id="colOff-instance_method"> + + - (<tt>Integer</tt>) <strong>colOff</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The offset distance from this marker’s column +</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"> + + +13 +14 +15</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 13</span> + +<span class='def def kw'>def</span> <span class='colOff identifier id'>colOff</span> + <span class='@colOff ivar id'>@colOff</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="row=-instance_method"></span> + <span id="row-instance_method"></span> + <div class="method_details "> + <p class="signature " id="row-instance_method"> + + - (<tt>Integer</tt>) <strong>row</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The row this marker anchors to +</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"> + + +17 +18 +19</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 17</span> + +<span class='def def kw'>def</span> <span class='row identifier id'>row</span> + <span class='@row ivar id'>@row</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="rowOff=-instance_method"></span> + <span id="rowOff-instance_method"></span> + <div class="method_details "> + <p class="signature " id="rowOff-instance_method"> + + - (<tt>Integer</tt>) <strong>rowOff</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The offset distance from this marker’s row +</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"> + + +21 +22 +23</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 21</span> + +<span class='def def kw'>def</span> <span class='rowOff identifier id'>rowOff</span> + <span class='@rowOff ivar id'>@rowOff</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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="coord-instance_method"> + + - (<tt>Object</tt>) <strong>coord</strong>(col, row) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +shortcut to set the column, row position for this marker +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>col</span> + + + <span class='type'></span> + + + + — + <div class='inline'><p> +the column for the marker +</p> +</div> + + </li> + + <li> + + <span class='name'>row</span> + + + <span class='type'></span> + + + + — + <div class='inline'><p> +the row of the marker +</p> +</div> + + </li> + +</ul> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +43 +44 +45 +46</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 43</span> + +<span class='def def kw'>def</span> <span class='coord identifier id'>coord</span><span class='lparen token'>(</span><span class='col identifier id'>col</span><span class='comma token'>,</span> <span class='row identifier id'>row</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='col identifier id'>col</span> <span class='assign token'>=</span> <span class='col identifier id'>col</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='row identifier id'>row</span> <span class='assign token'>=</span> <span class='row identifier id'>row</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 marker +</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"> + + +50 +51 +52 +53 +54</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 50</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='lbrack token'>[</span><span class='symbol val'>:col</span><span class='comma token'>,</span> <span class='symbol val'>:colOff</span><span class='comma token'>,</span> <span class='symbol val'>:row</span><span class='comma token'>,</span> <span class='symbol val'>:rowOff</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='k identifier id'>k</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"xdr:#{k.to_s}"</span><span class='comma token'>,</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='k identifier id'>k</span><span class='rparen token'>)</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43: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> + + </body> +</html>
\ No newline at end of file diff --git a/doc/Axlsx/NumFmt.html b/doc/Axlsx/NumFmt.html new file mode 100644 index 00000000..37a7fa6b --- /dev/null +++ b/doc/Axlsx/NumFmt.html @@ -0,0 +1,562 @@ +<!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::NumFmt + + — 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 (N)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">NumFmt</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::NumFmt + + + +</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::NumFmt</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/stylesheet/num_fmt.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 styles is Styles#add_style +</p> +</div> + </div> + +<p> +A NumFmt object defines an identifier and formatting code for data in +cells. +</p> + + + </div> +</div> +<div class="tags"> + + +</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="#formatCode-instance_method" title="#formatCode (instance method)">- (String) <strong>formatCode</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The formatting to use for this number format. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#numFmtId-instance_method" title="#numFmtId (instance method)">- (Integer) <strong>numFmtId</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +An unsinged integer referencing a standard or custom number format. +</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)">- (NumFmt) <strong>initialize</strong>(options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +A new instance of NumFmt. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#to_xml-instance_method" title="#to_xml (instance method)">- (Object) <strong>to_xml</strong>(xml) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a numFmt element applying the instance values of this object as +attributes. +</p> +</div></span> + +</li> + + + </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::NumFmt (class)">NumFmt</a></span></tt>) <strong>initialize</strong>(options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +A new instance of NumFmt +</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +45 +46 +47 +48 +49 +50 +51</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/num_fmt.rb', line 45</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='@numFmtId ivar id'>@numFmtId</span> <span class='assign token'>=</span> <span class='integer val'>0</span> + <span class='@formatCode ivar id'>@formatCode</span> <span class='assign token'>=</span> <span class='string val'>""</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="formatCode=-instance_method"></span> + <span id="formatCode-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="formatCode-instance_method"> + + - (<tt>String</tt>) <strong>formatCode</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The formatting to use for this number format. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +The formatting to use for this number format. +</p> +</div> + + </li> + +</ul> + + <h3>See Also:</h3> + <ul class="see"> + + <li><a href="http://support.microsoft.com/kb/264372" target="_parent" title="http://support.microsoft.com/kb/264372">http://support.microsoft.com/kb/264372</a></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/stylesheet/num_fmt.rb', line 44</span> + +<span class='def def kw'>def</span> <span class='formatCode identifier id'>formatCode</span> + <span class='@formatCode ivar id'>@formatCode</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="numFmtId=-instance_method"></span> + <span id="numFmtId-instance_method"></span> + <div class="method_details "> + <p class="signature " id="numFmtId-instance_method"> + + - (<tt>Integer</tt>) <strong>numFmtId</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +These are the known formats I can dig up. The constant NUM_FMT_PERCENT is +9, and uses the default % formatting. Axlsx also defines a few formats for +date and time that are commonly used in asia as NUM_FMT_YYYYMMDD and +NUM_FRM_YYYYMMDDHHMMSS. +</p> +<pre class="code"> + <span class='integer val'>1</span> <span class='integer val'>0</span> + <span class='integer val'>2</span> <span class='integer val'>0</span><span class='integer val'>.00</span> + <span class='integer val'>3</span> <span class='comment val'>#,##0</span> + <span class='integer val'>4</span> <span class='comment val'>#,##0.00</span> + <span class='integer val'>5</span> $<span class='comment val'>#,##0_);($#,##0)</span> + <span class='integer val'>6</span> $<span class='comment val'>#,##0_);[Red]($#,##0)</span> + <span class='integer val'>7</span> $<span class='comment val'>#,##0.00_);($#,##0.00)</span> + <span class='integer val'>8</span> $<span class='comment val'>#,##0.00_);[Red]($#,##0.00)</span> + <span class='integer val'>9</span> <span class='integer val'>0</span><span class='mod op'>%</span> + <span class='integer val'>10</span> <span class='integer val'>0</span><span class='integer val'>.00</span><span class='mod op'>%</span> + <span class='integer val'>11</span> <span class='integer val'>0</span><span class='float val'>.00E+00</span> + <span class='integer val'>12</span> <span class='comment val'># ?/?</span> + <span class='integer val'>13</span> <span class='comment val'># ??/??</span> + <span class='integer val'>14</span> <span class='m identifier id'>m</span><span class='div op'>/</span><span class='d identifier id'>d</span><span class='div op'>/</span><span class='yyyy identifier id'>yyyy</span> + <span class='integer val'>15</span> <span class='d identifier id'>d</span><span class='minus op'>-</span><span class='mmm identifier id'>mmm</span><span class='minus op'>-</span><span class='yy identifier id'>yy</span> + <span class='integer val'>16</span> <span class='d identifier id'>d</span><span class='minus op'>-</span><span class='mmm identifier id'>mmm</span> + <span class='integer val'>17</span> <span class='mmm identifier id'>mmm</span><span class='minus op'>-</span><span class='yy identifier id'>yy</span> + <span class='integer val'>18</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span> <span class='AM constant id'>AM</span><span class='div op'>/</span><span class='PM constant id'>PM</span> + <span class='integer val'>19</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span><span class='symbol val'>:ss</span> <span class='AM constant id'>AM</span><span class='div op'>/</span><span class='PM constant id'>PM</span> + <span class='integer val'>20</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span> + <span class='integer val'>21</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span><span class='symbol val'>:ss</span> + <span class='integer val'>22</span> <span class='m identifier id'>m</span><span class='div op'>/</span><span class='d identifier id'>d</span><span class='div op'>/</span><span class='yyyy identifier id'>yyyy</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span> + <span class='integer val'>37</span> <span class='comment val'>#,##0_);(#,##0)</span> + <span class='integer val'>38</span> <span class='comment val'>#,##0_);[Red](#,##0)</span> + <span class='integer val'>39</span> <span class='comment val'>#,##0.00_);(#,##0.00)</span> + <span class='integer val'>40</span> <span class='comment val'>#,##0.00_);[Red](#,##0.00)</span> + <span class='integer val'>45</span> <span class='mm identifier id'>mm</span><span class='symbol val'>:ss</span> + <span class='integer val'>46</span> <span class='lbrack token'>[</span><span class='h identifier id'>h</span><span class='rbrack token'>]</span><span class='symbol val'>:mm</span><span class='symbol val'>:ss</span> + <span class='integer val'>47</span> <span class='mm identifier id'>mm</span><span class='symbol val'>:ss</span><span class='integer val'>.0</span> + <span class='integer val'>48</span> <span class='comment val'>##0.0E+0</span> + <span class='integer val'>49</span> @ +</pre> +</div> + </div> + +<p> +An unsinged integer referencing a standard or custom number format. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +An unsinged integer referencing a standard or custom number format. +</p> +</div> + + </li> + +</ul> + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></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/stylesheet/num_fmt.rb', line 40</span> + +<span class='def def kw'>def</span> <span class='numFmtId identifier id'>numFmtId</span> + <span class='@numFmtId ivar id'>@numFmtId</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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>Object</tt>) <strong>to_xml</strong>(xml) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a numFmt element applying the instance values of this object as +attributes. +</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> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +58</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/num_fmt.rb', line 58</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='numFmt identifier id'>numFmt</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='rparen token'>)</span> <span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:44:00 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 new file mode 100644 index 00000000..992fd711 --- /dev/null +++ b/doc/Axlsx/Override.html @@ -0,0 +1,568 @@ +<!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::Override + + — 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">Override</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::Override + + + +</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::Override</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/content_type/override.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +An override content part. These parts are automatically created by for you +based on the content of your package. +</p> + + + </div> +</div> +<div class="tags"> + + +</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="#ContentType-instance_method" title="#ContentType (instance method)">- (String) <strong>ContentType</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +ContentType The type of content. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#PartName-instance_method" title="#PartName (instance method)">- (String) <strong>PartName</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +PartName The name and location of the part. +</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)">- (Override) <strong>initialize</strong>(options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new Override object. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#to_xml-instance_method" title="#to_xml (instance method)">- (Object) <strong>to_xml</strong>(xml) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Serializes the Override object to xml. +</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::Override (class)">Override</a></span></tt>) <strong>initialize</strong>(options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new Override object +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <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">PartName</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">ContentType</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + +<h3>Raises:</h3> +<ul class="raise"> + + <li> + + + <span class='type'>(<tt>ArgumentError</tt>)</span> + + + + — + <div class='inline'><p> +An argument error is raised if both PartName and ContentType are not +specified. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +15 +16 +17 +18 +19 +20</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line 15</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='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='string val'>"PartName and ContentType are required"</span> <span class='unless unless_mod kw'>unless</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:PartName</span><span class='rbrack token'>]</span> <span class='andop op'>&&</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:ContentType</span><span class='rbrack token'>]</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="ContentType=-instance_method"></span> + <span id="ContentType-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="ContentType-instance_method"> + + - (<tt>String</tt>) <strong>ContentType</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +ContentType The type of content. TABLE_CT, WORKBOOK_CT, APP_CT, RELS_CT, +STYLES_CT, XML_CT, WORKSHEET_CT, SHARED_STRINGS_CT, CORE_CT, CHART_CT, +DRAWING_CT are allowed +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +ContentType The type of content. TABLE_CT, WORKBOOK_CT, APP_CT, RELS_CT, +STYLES_CT, XML_CT, WORKSHEET_CT, SHARED_STRINGS_CT, CORE_CT, CHART_CT, +DRAWING_CT are allowed +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +6 +7 +8</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line 6</span> + +<span class='def def kw'>def</span> <span class='ContentType constant id'>ContentType</span> + <span class='@ContentType ivar id'>@ContentType</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="PartName=-instance_method"></span> + <span id="PartName-instance_method"></span> + <div class="method_details "> + <p class="signature " id="PartName-instance_method"> + + - (<tt>String</tt>) <strong>PartName</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +PartName The name and location of the part. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +PartName The name and location of the part. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +9 +10 +11</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line 9</span> + +<span class='def def kw'>def</span> <span class='PartName constant id'>PartName</span> + <span class='@PartName ivar id'>@PartName</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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>Object</tt>) <strong>to_xml</strong>(xml) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Serializes the Override object to xml +</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> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +26 +27 +28</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line 26</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='Override constant id'>Override</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43:58 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/Package.html b/doc/Axlsx/Package.html new file mode 100644 index 00000000..b7eecce2 --- /dev/null +++ b/doc/Axlsx/Package.html @@ -0,0 +1,1293 @@ +<!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::Package + + — 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">Package</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::Package + + + +</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::Package</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/package.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +Package is responsible for managing all the bits and peices that Open +Office XML requires to make a valid xlsx document including valdation and +serialization. +</p> + + + </div> +</div> +<div class="tags"> + + +</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="#workbook-instance_method" title="#workbook (instance method)">- (Workbook) <strong>workbook</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The workbook this package will serialize or validate. +</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="#base_content_types-instance_method" title="#base_content_types (instance method)">- (ContentType) <strong>base_content_types</strong> </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates the minimum content types for generating a valid xlsx document. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#content_types-instance_method" title="#content_types (instance method)">- (ContentType) <strong>content_types</strong> </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Appends override objects for drawings, charts, and sheets as they exist in +your workbook to the default content types. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#initialize-instance_method" title="#initialize (instance method)">- (Package) <strong>initialize</strong>(options = {}) {|_self| ... }</a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Initializes your package. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#parts-instance_method" title="#parts (instance method)">- (Array) <strong>parts</strong> </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The parts of a package. +</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> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates the relationships required for a valid xlsx document. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#serialize-instance_method" title="#serialize (instance method)">- (Boolean) <strong>serialize</strong>(output, confirm_valid = false) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Serialize your workbook to disk as an xlsx document. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#validate-instance_method" title="#validate (instance method)">- (Array) <strong>validate</strong> </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Validate all parts of the package against xsd schema. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#validate_single_doc-instance_method" title="#validate_single_doc (instance method)">- (Array) <strong>validate_single_doc</strong>(schema, doc) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Performs xsd validation for a signle document. +</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::Package (class)">Package</a></span></tt>) <strong>initialize</strong>(options = {}) {|_self| ... } + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Initializes your package +</p> + + + </div> +</div> +<div class="tags"> + + <div class="examples"> + <h3>Examples:</h3> + + <h4><div class='inline'><p> +Package.new :author => ‘you!’, :workbook => Workbook.new +</p> +</div></h4> + <pre class="example code"> +</pre> + + </div> +<h3>Parameters:</h3> +<ul class="param"> + + <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 hash that you can use to specify the author and workbook for this +package. +</p> +</div> + + </li> + +</ul> + + + + + <h3>Options Hash (<tt>options</tt>):</h3> + <ul class="option"> + + <li> + <span class="name">:author</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + — <div class='inline'><p> +The author of the document +</p> +</div> + </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::Package (class)">Axlsx::Package</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"> + + +28 +29 +30 +31 +32</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 28</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='@core ivar id'>@core</span><span class='comma token'>,</span> <span class='@app ivar id'>@app</span> <span class='assign token'>=</span> <span class='Core constant id'>Core</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='comma token'>,</span> <span class='App constant id'>App</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='@core ivar id'>@core</span><span class='dot token'>.</span><span class='creator identifier id'>creator</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:author</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='@core ivar id'>@core</span><span class='dot token'>.</span><span class='creator identifier id'>creator</span> + <span class='yield yield kw'>yield</span> <span class='self self kw'>self</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="workbook=-instance_method"></span> + <span id="workbook-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="workbook-instance_method"> + + - (<tt><span class='object_link'><a href="Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span></tt>) <strong>workbook</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +As there are multiple ways to instantiate a workbook for the package, here +are a few examples: +</p> +<pre class="code"> + <span class='comment val'># assign directly during package instanciation</span> + <span class='wb identifier id'>wb</span> <span class='assign token'>=</span> <span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:workbook</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Workbook constant id'>Workbook</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span> + + <span class='comment val'># get a fresh workbook automatically from the package</span> + <span class='wb identifier id'>wb</span> <span class='assign token'>=</span> <span class='Pacakge constant id'>Pacakge</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span> + <span class='comment val'># # set the workbook after creating the package</span> + <span class='wb identifier id'>wb</span> <span class='assign token'>=</span> <span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span> <span class='assign token'>=</span> <span class='Workbook constant id'>Workbook</span><span class='dot token'>.</span><span class='new identifier id'>new</span> +</pre> +</div> + </div> + +<p> +The workbook this package will serialize or validate. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span></tt>)</span> + + + + — + <div class='inline'><p> +If no workbook instance has been assigned with this package a new Workbook +instance is returned. +</p> +</div> + + </li> + +</ul> +<h3>Raises:</h3> +<ul class="raise"> + + <li> + + + <span class='type'></span> + + + + + <div class='inline'><p> +ArgumentError if workbook parameter is not a Workbook instance. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +21 +22 +23</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 21</span> + +<span class='def def kw'>def</span> <span class='workbook identifier id'>workbook</span> + <span class='@workbook ivar id'>@workbook</span> <span class='orop op'>||</span> <span class='@workbook ivar id'>@workbook</span> <span class='assign token'>=</span> <span class='Workbook constant id'>Workbook</span><span class='dot token'>.</span><span class='new identifier id'>new</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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="base_content_types-instance_method"> + + - (<tt><span class='object_link'><a href="ContentType.html" title="Axlsx::ContentType (class)">ContentType</a></span></tt>) <strong>base_content_types</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates the minimum content types for generating a valid xlsx document. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="ContentType.html" title="Axlsx::ContentType (class)">ContentType</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 156</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> + <span class='c_types identifier id'>c_types</span> <span class='lshft 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='RELS_CT constant id'>RELS_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='RELS_EX constant id'>RELS_EX</span><span class='rparen token'>)</span> + <span class='c_types identifier id'>c_types</span> <span class='lshft 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'>:Extension</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_EX constant id'>XML_EX</span><span class='comma token'>,</span> <span class='symbol val'>:ContentType</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_CT constant id'>XML_CT</span><span class='rparen token'>)</span> + <span class='c_types identifier id'>c_types</span> <span class='lshft 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'>"/#{APP_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='APP_CT constant id'>APP_CT</span><span class='rparen token'>)</span> + <span class='c_types identifier id'>c_types</span> <span class='lshft 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'>"/#{CORE_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='CORE_CT constant id'>CORE_CT</span><span class='rparen token'>)</span> + <span class='c_types identifier id'>c_types</span> <span class='lshft 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/#{STYLES_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='STYLES_CT constant id'>STYLES_CT</span><span class='rparen token'>)</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='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'>"/#{WORKBOOK_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='WORKBOOK_CT constant id'>WORKBOOK_CT</span><span class='rparen token'>)</span> + <span class='c_types identifier id'>c_types</span><span class='dot token'>.</span><span class='lock identifier id'>lock</span> + <span class='c_types identifier id'>c_types</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="content_types-instance_method"> + + - (<tt><span class='object_link'><a href="ContentType.html" title="Axlsx::ContentType (class)">ContentType</a></span></tt>) <strong>content_types</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Appends override objects for drawings, charts, and sheets as they exist in +your workbook to the default content types. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="ContentType.html" title="Axlsx::ContentType (class)">ContentType</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +136 +137 +138 +139 +140 +141 +142 +143 +144 +145 +146 +147 +148 +149 +150 +151</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 136</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> + <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='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='drawing identifier id'>drawing</span><span class='bitor op'>|</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='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/#{drawing.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='DRAWING_CT constant id'>DRAWING_CT</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> + <span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='charts identifier id'>charts</span><span class='dot token'>.</span><span class='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='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/#{chart.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='CHART_CT constant id'>CHART_CT</span><span class='rparen 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='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='c_types identifier id'>c_types</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="parts-instance_method"> + + - (<tt>Array</tt>) <strong>parts</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The parts of a package +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Array</tt>)</span> + + + + — + <div class='inline'><p> +An array of hashes that define the entry, document and schema for each part +of the package. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +90 +91 +92 +93 +94 +95 +96 +97 +98 +99 +100 +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 90</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> + <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='RELS_PN constant id'>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='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='comma token'>,</span> + <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='CORE_PN constant id'>CORE_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='@core ivar id'>@core</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='CORE_XSD constant id'>CORE_XSD</span><span class='rbrace token'>}</span><span class='comma token'>,</span> + <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='APP_PN constant id'>APP_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='@app ivar id'>@app</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='APP_XSD constant id'>APP_XSD</span><span class='rbrace token'>}</span><span class='comma token'>,</span> + <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='WORKBOOK_RELS_PN constant id'>WORKBOOK_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='workbook identifier id'>workbook</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='comma token'>,</span> + <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='WORKBOOK_PN constant id'>WORKBOOK_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='workbook identifier id'>workbook</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><span class='comma token'>,</span> + <span class='lbrace token'>{</span><span class='symbol val'>:entry</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='CONTENT_TYPES_PN constant id'>CONTENT_TYPES_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='content_types identifier id'>content_types</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='CONTENT_TYPES_XSD constant id'>CONTENT_TYPES_XSD</span><span class='rbrace token'>}</span><span class='comma token'>,</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/#{STYLES_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='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='styles identifier id'>styles</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> + <span class='rbrack 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='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='drawing identifier id'>drawing</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/#{drawing.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='drawing identifier id'>drawing</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/#{drawing.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='drawing identifier id'>drawing</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='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='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> + <span class='end end kw'>end</span> + <span class='@parts ivar id'>@parts</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="relationships-instance_method"> + + - (<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>) <strong>relationships</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates the relationships required for a valid xlsx document +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +171 +172 +173 +174 +175 +176 +177 +178</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 171</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> + <span class='rels identifier id'>rels</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='WORKBOOK_R constant id'>WORKBOOK_R</span><span class='comma token'>,</span> <span class='WORKBOOK_PN constant id'>WORKBOOK_PN</span><span class='rparen token'>)</span> + <span class='rels identifier id'>rels</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='CORE_R constant id'>CORE_R</span><span class='comma token'>,</span> <span class='CORE_PN constant id'>CORE_PN</span><span class='rparen token'>)</span> + <span class='rels identifier id'>rels</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='APP_R constant id'>APP_R</span><span class='comma token'>,</span> <span class='APP_PN constant id'>APP_PN</span><span class='rparen token'>)</span> + <span class='rels identifier id'>rels</span><span class='dot token'>.</span><span class='lock identifier id'>lock</span> + <span class='rels identifier id'>rels</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="serialize-instance_method"> + + - (<tt>Boolean</tt>) <strong>serialize</strong>(output, confirm_valid = false) + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +A tremendous amount of effort has gone into ensuring that you cannot create +invalid xlsx documents. confirm_valid should be used in the rare case that +you cannot open the serialized file. +</p> +</div> + </div> + +<p> +Serialize your workbook to disk as an xlsx document. +</p> + + + </div> +</div> +<div class="tags"> + + <div class="examples"> + <h3>Examples:</h3> + + <h4><div class='inline'></div></h4> + <pre class="example code"><span class='comment val'># This is how easy it is to create a valid xlsx file. Of course you might want to add a sheet or two, and maybe some data, styles and charts.</span> +<span class='comment val'># Take a look at the README for an example of how to do it!</span> +<span class='f identifier id'>f</span> <span class='assign token'>=</span> <span class='File constant id'>File</span><span class='dot token'>.</span><span class='open identifier id'>open</span><span class='lparen token'>(</span><span class='string val'>'test.xlsx'</span><span class='comma token'>,</span> <span class='string val'>'w'</span><span class='rparen token'>)</span> +<span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='f identifier id'>f</span><span class='rparen token'>)</span> + +<span class='comment val'># You will find a file called test.xlsx</span> +</pre> + + </div> +<h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>output</span> + + + <span class='type'>(<tt>File</tt>)</span> + + + + — + <div class='inline'><p> +The file you want to serialize your package to +</p> +</div> + + </li> + + <li> + + <span class='name'>confirm_valid</span> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + <em class="default">(defaults to: <tt>false</tt>)</em> + + + — + <div class='inline'><p> +Validate the package prior to serialization. +</p> +</div> + + </li> + +</ul> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + — + <div class='inline'><p> +False if confirm_valid and validation errors exist. True if the package was +serialized +</p> +</div> + + </li> + +</ul> + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="#validate-instance_method" title="Axlsx::Package#validate (method)">#validate</a></span></li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +55 +56 +57 +58 +59 +60 +61 +62</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='end end kw'>end</span> + <span class='true true kw'>true</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="validate-instance_method"> + + - (<tt>Array</tt>) <strong>validate</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +This gem includes all schema from OfficeOpenXML-XMLSchema-Transitional.zip +and OpenPackagingConventions-XMLSchema.zip as per ECMA-376, Third edition. +opc schema require an internet connection to import remote schema from +dublin core for dc, dcterms and xml namespaces. Those remote schema are +included in this gem, and the original files have been altered to refer to +the local versions. +</p> +<p> +If by chance you are able to creat a package that does not validate it +indicates that the internal validation is not robust enough and needs to be +improved. Please report your errors to the gem author. +</p> +</div> + </div> + +<p> +Validate all parts of the package against xsd schema. +</p> + + + </div> +</div> +<div class="tags"> + + <div class="examples"> + <h3>Examples:</h3> + + <h4><div class='inline'></div></h4> + <pre class="example code"><span class='comment val'># The following will output any error messages found in serialization.</span> +<span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> +<span class='comment val'># ... code to create sheets, charts, styles etc.</span> +<span class='p identifier id'>p</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='error identifier id'>error</span><span class='bitor op'>|</span> <span class='puts identifier id'>puts</span> <span class='error identifier id'>error</span><span class='dot token'>.</span><span class='message identifier id'>message</span> <span class='rbrace token'>}</span> +</pre> + + </div> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Array</tt>)</span> + + + + — + <div class='inline'><p> +An array of all validation errors found. +</p> +</div> + + </li> + +</ul> + + <h3>See Also:</h3> + <ul class="see"> + + <li><a href="http://www.ecma-international.org/publications/standards/Ecma-376.htm" target="_parent" title="http://www.ecma-international.org/publications/standards/Ecma-376.htm">http://www.ecma-international.org/publications/standards/Ecma-376.htm</a></li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +79 +80 +81 +82 +83</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 79</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='errors identifier id'>errors</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="validate_single_doc-instance_method"> + + - (<tt>Array</tt>) <strong>validate_single_doc</strong>(schema, doc) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Performs xsd validation for a signle document +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>schema</span> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +path to the xsd schema to be used in validation. +</p> +</div> + + </li> + + <li> + + <span class='name'>doc</span> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +The xml text to be validated +</p> +</div> + + </li> + +</ul> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Array</tt>)</span> + + + + — + <div class='inline'><p> +An array of all validation errors encountered. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +122 +123 +124 +125 +126 +127 +128 +129 +130 +131</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 122</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> + <span class='doc identifier id'>doc</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='lparen token'>(</span><span class='doc identifier id'>doc</span><span class='rparen token'>)</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='schema identifier id'>schema</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='lparen token'>(</span><span class='doc identifier id'>doc</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='error identifier id'>error</span><span class='bitor op'>|</span> + <span class='errors identifier id'>errors</span> <span class='lshft op'><<</span> <span class='error identifier id'>error</span> + <span class='end end kw'>end</span> + <span class='errors identifier id'>errors</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43:57 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/PatternFill.html b/doc/Axlsx/PatternFill.html new file mode 100644 index 00000000..501cd1cb --- /dev/null +++ b/doc/Axlsx/PatternFill.html @@ -0,0 +1,681 @@ +<!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::PatternFill + + — 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">PatternFill</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::PatternFill + + + +</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::PatternFill</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/stylesheet/pattern_fill.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 styles is with Styles#add_style +</p> +</div> + </div> + +<p> +A PatternFill is the pattern and solid fill styling for a cell. +</p> + + + </div> +</div> +<div class="tags"> + + + <h3>See Also:</h3> + <ul class="see"> + + <li>Style#add_style</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="#bgColor-instance_method" title="#bgColor (instance method)">- (Color) <strong>bgColor</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The color to use for the background of the fill when the type is not solid. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#fgColor-instance_method" title="#fgColor (instance method)">- (Color) <strong>fgColor</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The color to use for the the background in solid fills. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#patternType-instance_method" title="#patternType (instance method)">- (Object) <strong>patternType</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The pattern type to use. +</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)">- (PatternFill) <strong>initialize</strong>(options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new PatternFill Object. +</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 pattern fill. +</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::PatternFill (class)">PatternFill</a></span></tt>) <strong>initialize</strong>(options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new PatternFill Object +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <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">patternType</span> + <span class="type">(<tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">fgColor</span> + <span class="type">(<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">bgColor</span> + <span class="type">(<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +44 +45 +46 +47 +48 +49</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/pattern_fill.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='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@patternType ivar id'>@patternType</span> <span class='assign token'>=</span> <span class='symbol val'>:none</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="bgColor=-instance_method"></span> + <span id="bgColor-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="bgColor-instance_method"> + + - (<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>) <strong>bgColor</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The color to use for the background of the fill when the type is not solid. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></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/stylesheet/pattern_fill.rb', line 13</span> + +<span class='def def kw'>def</span> <span class='bgColor identifier id'>bgColor</span> + <span class='@bgColor ivar id'>@bgColor</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="fgColor=-instance_method"></span> + <span id="fgColor-instance_method"></span> + <div class="method_details "> + <p class="signature " id="fgColor-instance_method"> + + - (<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>) <strong>fgColor</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The color to use for the the background in solid fills. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +9 +10 +11</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/pattern_fill.rb', line 9</span> + +<span class='def def kw'>def</span> <span class='fgColor identifier id'>fgColor</span> + <span class='@fgColor ivar id'>@fgColor</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="patternType=-instance_method"></span> + <span id="patternType-instance_method"></span> + <div class="method_details "> + <p class="signature " id="patternType-instance_method"> + + - (<tt>Object</tt>) <strong>patternType</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +patternType must be one of +</p> +<pre class="code"> + <span class='symbol val'>:none</span> + <span class='symbol val'>:solid</span> + <span class='symbol val'>:mediumGray</span> + <span class='symbol val'>:darkGray</span> + <span class='symbol val'>:lightGray</span> + <span class='symbol val'>:darkHorizontal</span> + <span class='symbol val'>:darkVertical</span> + <span class='symbol val'>:darkDown</span> + <span class='symbol val'>:darkUp</span> + <span class='symbol val'>:darkGrid</span> + <span class='symbol val'>:darkTrellis</span> + <span class='symbol val'>:lightHorizontal</span> + <span class='symbol val'>:lightVertical</span> + <span class='symbol val'>:lightDown</span> + <span class='symbol val'>:lightUp</span> + <span class='symbol val'>:lightGrid</span> + <span class='symbol val'>:lightTrellis</span> + <span class='symbol val'>:gray125</span> + <span class='symbol val'>:gray0625</span> +</pre> +</div> + </div> + +<p> +The pattern type to use +</p> + + + </div> +</div> +<div class="tags"> + + + <h3>See Also:</h3> + <ul class="see"> + + <li>Open XML Part 1 18.18.55</li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +38 +39 +40</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/pattern_fill.rb', line 38</span> + +<span class='def def kw'>def</span> <span class='patternType identifier id'>patternType</span> + <span class='@patternType ivar id'>@patternType</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 pattern fill +</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"> + + +58 +59 +60 +61 +62</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/pattern_fill.rb', line 58</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='patternFill identifier id'>patternFill</span><span class='lparen token'>(</span><span class='symbol val'>:patternType</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='patternType identifier id'>patternType</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='dot token'>.</span><span class='reject identifier id'>reject</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='k identifier id'>k</span><span class='comma token'>,</span><span class='v identifier id'>v</span><span class='bitor op'>|</span> <span class='k identifier id'>k</span><span class='dot token'>.</span><span class='to_sym identifier id'>to_sym</span> <span class='eq op'>==</span> <span class='symbol val'>:patternType</span> <span class='rbrace token'>}</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='k identifier id'>k</span><span class='comma token'>,</span><span class='v identifier id'>v</span><span class='bitor op'>|</span> <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='k identifier id'>k</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43:59 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 new file mode 100644 index 00000000..e3b3e318 --- /dev/null +++ b/doc/Axlsx/Pie3DChart.html @@ -0,0 +1,439 @@ +<!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::Pie3DChart + + — 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">Pie3DChart</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::Pie3DChart + + + +</h1> + +<dl class="box"> + + <dt class="r1">Inherits:</dt> + <dd class="r1"> + <span class="inheritName"><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></span> + + <ul class="fullTree"> + <li>Object</li> + + <li class="next"><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></li> + + <li class="next">Axlsx::Pie3DChart</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/drawing/pie_3D_chart.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +The Pie3DChart is a three dimentional piechart (who would have guessed?) +that you can add to your worksheet. +</p> + + + </div> +</div> +<div class="tags"> + + <div class="examples"> + <h3>Examples:</h3> + + <h4><div class='inline'><p> +Creating a chart +</p> +</div></h4> + <pre class="example code"><span class='comment val'># This example creates two charts in a single sheet.</span> +<span class='comment val'># The first uses data directly fed to the sheet, while the second references cells withing the worksheet for data.</span> + +<span class='require identifier id'>require</span> <span class='string val'>"rubygems"</span> <span class='comment val'># if that is your preferred way to manage gems!</span> +<span class='require identifier id'>require</span> <span class='string val'>"axlsx"</span> + +<span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> +<span class='ws identifier id'>ws</span> <span class='assign token'>=</span> <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> +<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"This is a chart with no data in the sheet"</span><span class='rbrack token'>]</span> + +<span class='chart identifier id'>chart</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Pie3DChart constant id'>Pie3DChart</span><span class='comma token'>,</span> <span class='symbol val'>:start_at=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:end_at=</span><span class='gt op'>></span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>6</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:title=</span><span class='gt op'>></span><span class='string val'>"Most Popular Pets"</span><span class='rparen token'>)</span> +<span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='add_series identifier id'>add_series</span> <span class='symbol val'>:data</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>9</span><span class='comma token'>,</span> <span class='integer val'>10</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:labels</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Slimy Reptiles"</span><span class='comma token'>,</span> <span class='string val'>"Fuzzy Bunnies"</span><span class='comma token'>,</span> <span class='string val'>"Rottweiler"</span><span class='rbrack token'>]</span> + +<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"This chart uses the data below"</span><span class='rbrack token'>]</span> +<span class='title_row identifier id'>title_row</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Least Popular Pets"</span><span class='rbrack token'>]</span> +<span class='label_row identifier id'>label_row</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>""</span><span class='comma token'>,</span> <span class='string val'>"Dry Skinned Reptiles"</span><span class='comma token'>,</span> <span class='string val'>"Bald Cats"</span><span class='comma token'>,</span> <span class='string val'>"Violent Parrots"</span><span class='rbrack token'>]</span> +<span class='data_row identifier id'>data_row</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Votes"</span><span class='comma token'>,</span> <span class='integer val'>6</span><span class='comma token'>,</span> <span class='integer val'>4</span><span class='comma token'>,</span> <span class='integer val'>1</span><span class='rbrack token'>]</span> + +<span class='chart identifier id'>chart</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Pie3DChart constant id'>Pie3DChart</span><span class='comma token'>,</span> <span class='symbol val'>:start_at</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>11</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:end_at</span> <span class='assign token'>=</span><span class='gt op'>></span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>16</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:title</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='title_row identifier id'>title_row</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='rparen token'>)</span> +<span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='add_series identifier id'>add_series</span> <span class='symbol val'>:data</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='data_row identifier id'>data_row</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='lbrack token'>[</span><span class='lparen token'>(</span><span class='float val'>1</span><span class='dot2 op'>..</span><span class='integer val'>-1</span><span class='rparen token'>)</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:labels</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='label_row identifier id'>label_row</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span> + +<span class='f identifier id'>f</span> <span class='assign token'>=</span> <span class='File constant id'>File</span><span class='dot token'>.</span><span class='open identifier id'>open</span><span class='lparen token'>(</span><span class='string val'>'example_pie_3d_chart.xlsx'</span><span class='comma token'>,</span> <span class='string val'>'w'</span><span class='rparen token'>)</span> +<span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='f identifier id'>f</span><span class='rparen token'>)</span> +</pre> + + </div> + + + <h3>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_row-instance_method" title="Axlsx::Worksheet#add_row (method)">Worksheet#add_row</a></span></li> + + <li><span class='object_link'><a href="Chart.html#add_series-instance_method" title="Axlsx::Chart#add_series (method)">Chart#add_series</a></span></li> + + <li><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></li> + + <li><span class='object_link'><a href="Package.html#serialize-instance_method" title="Axlsx::Package#serialize (method)">Axlsx::Package#serialize</a></span></li> + + </ul> + +</div> + + + + + + + + + + + <h2>Instance Attribute Summary</h2> + + <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></h3> + <p class="inherited"><span class='object_link'><a href="Chart.html#end_at-instance_method" title="Axlsx::Chart#end_at (method)">end_at</a></span>, <span class='object_link'><a href="Chart.html#graphic_frame-instance_method" title="Axlsx::Chart#graphic_frame (method)">graphic_frame</a></span>, <span class='object_link'><a href="Chart.html#index-instance_method" title="Axlsx::Chart#index (method)">index</a></span>, <span class='object_link'><a href="Chart.html#pn-instance_method" title="Axlsx::Chart#pn (method)">pn</a></span>, <span class='object_link'><a href="Chart.html#series-instance_method" title="Axlsx::Chart#series (method)">series</a></span>, <span class='object_link'><a href="Chart.html#series_type-instance_method" title="Axlsx::Chart#series_type (method)">series_type</a></span>, <span class='object_link'><a href="Chart.html#show_legend-instance_method" title="Axlsx::Chart#show_legend (method)">show_legend</a></span>, <span class='object_link'><a href="Chart.html#start_at-instance_method" title="Axlsx::Chart#start_at (method)">start_at</a></span>, <span class='object_link'><a href="Chart.html#title-instance_method" title="Axlsx::Chart#title (method)">title</a></span>, <span class='object_link'><a href="Chart.html#view3D-instance_method" title="Axlsx::Chart#view3D (method)">view3D</a></span></p> + + + + <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)">- (Pie3DChart) <strong>initialize</strong>(workbook, options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new pie chart object. +</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> </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Serializes the pie chart. +</p> +</div></span> + +</li> + + + </ul> + + + + + + + + + + + <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></h3> + <p class="inherited"><span class='object_link'><a href="Chart.html#add_series-instance_method" title="Axlsx::Chart#add_series (method)">#add_series</a></span></p> +<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::Pie3DChart (class)">Pie3DChart</a></span></tt>) <strong>initialize</strong>(workbook, options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new pie chart object +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>workbook</span> + + + <span class='type'>(<tt><span class='object_link'><a href="Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span></tt>)</span> + + + + — + <div class='inline'><p> +The workbook that owns this chart. +</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">title</span> + <span class="type">(<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>, <tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +41 +42 +43 +44 +45 +46</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pie_3D_chart.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='workbook identifier id'>workbook</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='workbook identifier id'>workbook</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='comment val'># this charts series type</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='symbol val'>:rotX</span> <span class='assign token'>=</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='assign token'>=</span><span class='gt op'>></span> <span class='integer val'>30</span><span class='rparen token'>)</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> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Serializes the pie chart +</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"> + + +50 +51 +52 +53 +54 +55 +56 +57</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pie_3D_chart.rb', line 50</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> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:pie3DChart'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:varyColors'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='integer val'>1</span><span class='rparen token'>)</span> + <span class='@series ivar id'>@series</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='ser identifier id'>ser</span><span class='bitor op'>|</span> <span class='ser identifier id'>ser</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43: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> + + </body> +</html>
\ No newline at end of file diff --git a/doc/Axlsx/PieSeries.html b/doc/Axlsx/PieSeries.html new file mode 100644 index 00000000..b100d89d --- /dev/null +++ b/doc/Axlsx/PieSeries.html @@ -0,0 +1,762 @@ +<!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::PieSeries + + — 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">PieSeries</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::PieSeries + + + +</h1> + +<dl class="box"> + + <dt class="r1">Inherits:</dt> + <dd class="r1"> + <span class="inheritName"><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></span> + + <ul class="fullTree"> + <li>Object</li> + + <li class="next"><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></li> + + <li class="next">Axlsx::PieSeries</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/drawing/pie_series.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 series is to use Chart#add_series +</p> +</div> + </div> + +<p> +A PieSeries defines the title, data and labels for pie charts +</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="Chart.html#add_series-instance_method" title="Axlsx::Chart#add_series (method)">Chart#add_series</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="#data-instance_method" title="#data (instance method)">- (Array, SimpleTypedList) <strong>data</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The data for this series. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#explosion-instance_method" title="#explosion (instance method)">- (Array, SimpleTypedList) <strong>explosion</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The explosion for this series. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#labels-instance_method" title="#labels (instance method)">- (Array, SimpleTypedList) <strong>labels</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The labels for this series. +</p> +</div></span> + +</li> + + + </ul> + + + + + + + + + <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></h3> + <p class="inherited"><span class='object_link'><a href="Series.html#chart-instance_method" title="Axlsx::Series#chart (method)">chart</a></span>, <span class='object_link'><a href="Series.html#index-instance_method" title="Axlsx::Series#index (method)">index</a></span>, <span class='object_link'><a href="Series.html#order-instance_method" title="Axlsx::Series#order (method)">order</a></span>, <span class='object_link'><a href="Series.html#title-instance_method" title="Axlsx::Series#title (method)">title</a></span></p> + + + + <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)">- (PieSeries) <strong>initialize</strong>(chart, options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new series. +</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 series. +</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::PieSeries (class)">PieSeries</a></span></tt>) <strong>initialize</strong>(chart, options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new series +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>chart</span> + + + <span class='type'>(<tt><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</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">data</span> + <span class="type">(<tt>Array</tt>, <tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">labels</span> + <span class="type">(<tt>Array</tt>, <tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">title</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">explosion</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +28 +29 +30 +31 +32</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pie_series.rb', line 28</span> + +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='chart identifier id'>chart</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='chart identifier id'>chart</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='data identifier id'>data</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:data</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='labels identifier id'>labels</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:labels</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='lbrack token'>[</span><span class='rbrack 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="data=-instance_method"></span> + <span id="data-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="data-instance_method"> + + - (<tt>Array</tt>, <tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>data</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The data for this series. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Array</tt>, <tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</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/pie_series.rb', line 10</span> + +<span class='def def kw'>def</span> <span class='data identifier id'>data</span> + <span class='@data ivar id'>@data</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="explosion=-instance_method"></span> + <span id="explosion-instance_method"></span> + <div class="method_details "> + <p class="signature " id="explosion-instance_method"> + + - (<tt>Array</tt>, <tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>explosion</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The explosion for this series +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Array</tt>, <tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +20 +21 +22</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pie_series.rb', line 20</span> + +<span class='def def kw'>def</span> <span class='explosion identifier id'>explosion</span> + <span class='@explosion ivar id'>@explosion</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="labels=-instance_method"></span> + <span id="labels-instance_method"></span> + <div class="method_details "> + <p class="signature " id="labels-instance_method"> + + - (<tt>Array</tt>, <tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>labels</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The labels for this series. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Array</tt>, <tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +15 +16 +17</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pie_series.rb', line 15</span> + +<span class='def def kw'>def</span> <span class='labels identifier id'>labels</span> + <span class='@labels ivar id'>@labels</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 series +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>xml</span> + + + <span class='type'>(<tt>Nokogiri::XML::Builder</tt>)</span> + + + + — + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> +</div> + + </li> + +</ul> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +38 +39 +40 +41 +42 +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57 +58 +59 +60 +61 +62 +63 +64 +65 +66 +67 +68 +69 +70 +71 +72 +73 +74</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pie_series.rb', line 38</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> + <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:explosion'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@explosion ivar id'>@explosion</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@explosion ivar id'>@explosion</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='if if kw'>if</span> <span class='notop op'>!</span><span class='labels identifier id'>labels</span><span class='dot token'>.</span><span class='empty? fid id'>empty?</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:cat'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:strRef'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:f'</span><span class='comma token'>,</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='cell_range identifier id'>cell_range</span><span class='lparen token'>(</span><span class='labels identifier id'>labels</span><span class='rparen token'>)</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:strCache'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:ptCount'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='labels identifier id'>labels</span><span class='dot token'>.</span><span class='size identifier id'>size</span><span class='rparen token'>)</span> + <span class='labels identifier id'>labels</span><span class='dot token'>.</span><span class='each_with_index identifier id'>each_with_index</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='cell identifier id'>cell</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span> + <span class='v identifier id'>v</span> <span class='assign token'>=</span> <span class='cell identifier id'>cell</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Cell constant id'>Cell</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='cell identifier id'>cell</span><span class='dot token'>.</span><span class='value identifier id'>value</span> <span class='colon op'>:</span> <span class='cell identifier id'>cell</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:pt'</span><span class='comma token'>,</span> <span class='symbol val'>:idx=</span><span class='gt op'>></span><span class='index identifier id'>index</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:v'</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:val'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:numRef'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:f'</span><span class='comma token'>,</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='cell_range identifier id'>cell_range</span><span class='lparen token'>(</span><span class='data identifier id'>data</span><span class='rparen token'>)</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:numCache'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:formatCode'</span><span class='comma token'>,</span> <span class='string val'>'General'</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:ptCount'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='data identifier id'>data</span><span class='dot token'>.</span><span class='size identifier id'>size</span><span class='rparen token'>)</span> + <span class='data identifier id'>data</span><span class='dot token'>.</span><span class='each_with_index identifier id'>each_with_index</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='cell identifier id'>cell</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span> + <span class='v identifier id'>v</span> <span class='assign token'>=</span> <span class='cell identifier id'>cell</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Cell constant id'>Cell</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='cell identifier id'>cell</span><span class='dot token'>.</span><span class='value identifier id'>value</span> <span class='colon op'>:</span> <span class='cell identifier id'>cell</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:pt'</span><span class='comma token'>,</span> <span class='symbol val'>:idx=</span><span class='gt op'>></span><span class='index identifier id'>index</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:v'</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43:59 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/RegexValidator.html b/doc/Axlsx/RegexValidator.html new file mode 100644 index 00000000..41ea5e3a --- /dev/null +++ b/doc/Axlsx/RegexValidator.html @@ -0,0 +1,268 @@ +<!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::RegexValidator + + — 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 (R)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">RegexValidator</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::RegexValidator + + + +</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::RegexValidator</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/util/validators.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +Validates the value against the regular expression provided. +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + + + + + + <h2> + Class Method Summary + <small>(<a href="#" class="summary_toggle">collapse</a>)</small> + </h2> + + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> + + <a href="#validate-class_method" title="validate (class method)">+ (Object) <strong>validate</strong>(name, regex, v) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'></div></span> + +</li> + + + </ul> + + + + + <div id="class_method_details" class="method_details_list"> + <h2>Class Method Details</h2> + + + <div class="method_details first"> + <p class="signature first" id="validate-class_method"> + + + (<tt>Object</tt>) <strong>validate</strong>(name, regex, v) + + + +</p><div class="docstring"> + <div class="discussion"> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>name</span> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +The name of what is being validated. This is included in the output when +the value is invalid +</p> +</div> + + </li> + + <li> + + <span class='name'>regex</span> + + + <span class='type'>(<tt>Regexp</tt>)</span> + + + + — + <div class='inline'><p> +The regular expression to evaluate +</p> +</div> + + </li> + + <li> + + <span class='name'>v</span> + + + <span class='type'>(<tt>Any</tt>)</span> + + + + — + <div class='inline'><p> +The value to validate. +</p> +</div> + + </li> + +</ul> + +<h3>Raises:</h3> +<ul class="raise"> + + <li> + + + <span class='type'>(<tt>ArgumentError</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +21 +22 +23</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 21</span> + +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='regex identifier id'>regex</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='lparen token'>(</span><span class='ERR_REGEX constant id'>ERR_REGEX</span> <span class='mod op'>%</span> <span class='lbrack token'>[</span><span class='v identifier id'>v</span><span class='dot token'>.</span><span class='inspect identifier id'>inspect</span><span class='comma token'>,</span> <span class='regex identifier id'>regex</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span><span class='lparen token'>(</span><span class='symbol val'>:=~</span><span class='rparen token'>)</span> <span class='andop op'>&&</span> <span class='v identifier id'>v</span> <span class='match op'>=~</span> <span class='regex identifier id'>regex</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43:54 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/Relationship.html b/doc/Axlsx/Relationship.html new file mode 100644 index 00000000..9d94f557 --- /dev/null +++ b/doc/Axlsx/Relationship.html @@ -0,0 +1,554 @@ +<!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::Relationship + + — 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 (R)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">Relationship</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::Relationship + + + +</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::Relationship</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/rels/relationship.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> +Packages automatcially manage relationships. +</p> +</div> + </div> + +<p> +A relationship defines a reference between package parts. +</p> + + + </div> +</div> +<div class="tags"> + + +</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="#Target-instance_method" title="#Target (instance method)">- (String) <strong>Target</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The location of the relationship target. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#Type-instance_method" title="#Type (instance method)">- (String) <strong>Type</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The type of relationship. +</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)">- (Relationship) <strong>initialize</strong>(type, target) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +A new instance of Relationship. +</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, rId) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Serializes the relationship TODO: use object.rId to get this infomation. +</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::Relationship (class)">Relationship</a></span></tt>) <strong>initialize</strong>(type, target) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +A new instance of Relationship +</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +24 +25 +26 +27</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/rels/relationship.rb', line 24</span> + +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='type identifier id'>type</span><span class='comma token'>,</span> <span class='target identifier id'>target</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='Target constant id'>Target</span><span class='assign token'>=</span><span class='target identifier id'>target</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='Type constant id'>Type</span><span class='assign token'>=</span><span class='type identifier id'>type</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="Target=-instance_method"></span> + <span id="Target-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="Target-instance_method"> + + - (<tt>String</tt>) <strong>Target</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The location of the relationship target +</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"> + + +8 +9 +10</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/rels/relationship.rb', line 8</span> + +<span class='def def kw'>def</span> <span class='Target constant id'>Target</span> + <span class='@Target ivar id'>@Target</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="Type=-instance_method"></span> + <span id="Type-instance_method"></span> + <div class="method_details "> + <p class="signature " id="Type-instance_method"> + + - (<tt>String</tt>) <strong>Type</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +Supported types are defined as constants in Axlsx: +</p> +</div> + </div> + +<p> +The type of relationship +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + </li> + +</ul> + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="../Axlsx.html#XML_NS_R-constant" title="Axlsx::XML_NS_R (constant)">XML_NS_R</a></span></li> + + <li><span class='object_link'><a href="../Axlsx.html#TABLE_R-constant" title="Axlsx::TABLE_R (constant)">TABLE_R</a></span></li> + + <li><span class='object_link'><a href="../Axlsx.html#WORKBOOK_R-constant" title="Axlsx::WORKBOOK_R (constant)">WORKBOOK_R</a></span></li> + + <li><span class='object_link'><a href="../Axlsx.html#WORKSHEET_R-constant" title="Axlsx::WORKSHEET_R (constant)">WORKSHEET_R</a></span></li> + + <li><span class='object_link'><a href="../Axlsx.html#APP_R-constant" title="Axlsx::APP_R (constant)">APP_R</a></span></li> + + <li><span class='object_link'><a href="../Axlsx.html#RELS_R-constant" title="Axlsx::RELS_R (constant)">Axlsx::RELS_R</a></span></li> + + <li><span class='object_link'><a href="../Axlsx.html#CORE_R-constant" title="Axlsx::CORE_R (constant)">CORE_R</a></span></li> + + <li><span class='object_link'><a href="../Axlsx.html#STYLES_R-constant" title="Axlsx::STYLES_R (constant)">STYLES_R</a></span></li> + + <li><span class='object_link'><a href="../Axlsx.html#CHART_R-constant" title="Axlsx::CHART_R (constant)">CHART_R</a></span></li> + + <li><span class='object_link'><a href="../Axlsx.html#DRAWING_R-constant" title="Axlsx::DRAWING_R (constant)">DRAWING_R</a></span></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/rels/relationship.rb', line 23</span> + +<span class='def def kw'>def</span> <span class='Type constant id'>Type</span> + <span class='@Type ivar id'>@Type</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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, rId) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Serializes the relationship TODO: use object.rId to get this infomation +</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> + + <li> + + <span class='name'>rId</span> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +the reference id of the object. +</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"> + + +37 +38 +39 +40 +41</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/rels/relationship.rb', line 37</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> + <span class='h identifier id'>h</span><span class='lbrack token'>[</span><span class='symbol val'>:Id</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rId identifier id'>rId</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='Relationship constant id'>Relationship</span><span class='lparen token'>(</span><span class='h identifier id'>h</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43:54 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/Relationships.html b/doc/Axlsx/Relationships.html new file mode 100644 index 00000000..d5e76faf --- /dev/null +++ b/doc/Axlsx/Relationships.html @@ -0,0 +1,343 @@ +<!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::Relationships + + — 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 (R)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">Relationships</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::Relationships + + + +</h1> + +<dl class="box"> + + <dt class="r1">Inherits:</dt> + <dd class="r1"> + <span class="inheritName"><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></span> + + <ul class="fullTree"> + <li>Object</li> + + <li class="next"><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></li> + + <li class="next">Axlsx::Relationships</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/rels/relationships.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 package automatically manages releationships. +</p> +</div> + </div> + +<p> +Relationships are a collection of Relations that define how package parts +are related. +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + + + + + + + + + + + <h2>Instance Attribute Summary</h2> + + <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></h3> + <p class="inherited"><span class='object_link'><a href="SimpleTypedList.html#allowed_types-instance_method" title="Axlsx::SimpleTypedList#allowed_types (method)">allowed_types</a></span>, <span class='object_link'><a href="SimpleTypedList.html#locked_at-instance_method" title="Axlsx::SimpleTypedList#locked_at (method)">locked_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#serialize_as-instance_method" title="Axlsx::SimpleTypedList#serialize_as (method)">serialize_as</a></span></p> + + + + <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)">- (Relationships) <strong>initialize</strong> </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new Relationships collection based on SimpleTypedList. +</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> </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Serializes the relationships document. +</p> +</div></span> + +</li> + + + </ul> + + + + + + + + + + + <h3 class="inherited">Methods inherited from <span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></h3> + <p class="inherited"><span class='object_link'><a href="SimpleTypedList.html#%3C%3C-instance_method" title="Axlsx::SimpleTypedList#<< (method)">#<<</a></span>, <span class='object_link'><a href="SimpleTypedList.html#%5B%5D%3D-instance_method" title="Axlsx::SimpleTypedList#[]= (method)">#[]=</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete-instance_method" title="Axlsx::SimpleTypedList#delete (method)">#delete</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete_at-instance_method" title="Axlsx::SimpleTypedList#delete_at (method)">#delete_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#lock-instance_method" title="Axlsx::SimpleTypedList#lock (method)">#lock</a></span>, <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">#method_missing</a></span>, <span class='object_link'><a href="SimpleTypedList.html#protected%3F-instance_method" title="Axlsx::SimpleTypedList#protected? (method)">#protected?</a></span>, <span class='object_link'><a href="SimpleTypedList.html#push-instance_method" title="Axlsx::SimpleTypedList#push (method)">#push</a></span>, <span class='object_link'><a href="SimpleTypedList.html#unlock-instance_method" title="Axlsx::SimpleTypedList#unlock (method)">#unlock</a></span></p> +<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::Relationships (class)">Relationships</a></span></tt>) <strong>initialize</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new Relationships collection based on SimpleTypedList +</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +9 +10 +11</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/rels/relationships.rb', line 9</span> + +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span> + <span class='super super kw'>super</span> <span class='Relationship constant id'>Relationship</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> +<div id="method_missing_details" class="method_details_list"> + <h2>Dynamic Method Handling</h2> + <p class="notice super"> + This class handles dynamic methods through the <tt>method_missing</tt> method + + in the class <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">Axlsx::SimpleTypedList</a></span> + + </p> + +</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> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Serializes the relationships document. +</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"> + + +15 +16 +17 +18 +19 +20 +21 +22</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/rels/relationships.rb', line 15</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='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='Relationships constant id'>Relationships</span><span class='lparen token'>(</span><span class='symbol val'>:xmlns</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='RELS_R constant id'>RELS_R</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='each_with_index identifier id'>each_with_index</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='rel identifier id'>rel</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span> <span class='rel identifier id'>rel</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='comma token'>,</span> <span class='dstring node'>"rId#{index+1}"</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43:56 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/RestrictionValidator.html b/doc/Axlsx/RestrictionValidator.html new file mode 100644 index 00000000..a9020501 --- /dev/null +++ b/doc/Axlsx/RestrictionValidator.html @@ -0,0 +1,300 @@ +<!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::RestrictionValidator + + — 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 (R)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">RestrictionValidator</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::RestrictionValidator + + + +</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::RestrictionValidator</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/util/validators.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +Validate a value against a specific list of allowed values. +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + + + + + + <h2> + Class Method Summary + <small>(<a href="#" class="summary_toggle">collapse</a>)</small> + </h2> + + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> + + <a href="#validate-class_method" title="validate (class method)">+ (Boolean) <strong>validate</strong>(name, choices, v) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Perform validation. +</p> +</div></span> + +</li> + + + </ul> + + + + + <div id="class_method_details" class="method_details_list"> + <h2>Class Method Details</h2> + + + <div class="method_details first"> + <p class="signature first" id="validate-class_method"> + + + (<tt>Boolean</tt>) <strong>validate</strong>(name, choices, v) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Perform validation +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>name</span> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +The name of what is being validatied. This is included in the error message +</p> +</div> + + </li> + + <li> + + <span class='name'>choices</span> + + + <span class='type'>(<tt>Array</tt>)</span> + + + + — + <div class='inline'><p> +The list of choices to validate against +</p> +</div> + + </li> + + <li> + + <span class='name'>v</span> + + + <span class='type'>(<tt>Any</tt>)</span> + + + + — + <div class='inline'><p> +The value to be validated +</p> +</div> + + </li> + +</ul> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + — + <div class='inline'><p> +true if validation succeeds. +</p> +</div> + + </li> + +</ul> +<h3>Raises:</h3> +<ul class="raise"> + + <li> + + + <span class='type'>(<tt>ArgumentError</tt>)</span> + + + + — + <div class='inline'><p> +Raised if the value provided is not in the list of choices. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +10 +11 +12 +13</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 10</span> + +<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='choices identifier id'>choices</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='lparen token'>(</span><span class='ERR_RESTRICTION constant id'>ERR_RESTRICTION</span> <span class='mod op'>%</span> <span class='lbrack token'>[</span><span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='comma token'>,</span> <span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='choices identifier id'>choices</span><span class='dot token'>.</span><span class='inspect identifier id'>inspect</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='choices identifier id'>choices</span><span class='dot token'>.</span><span class='include? fid id'>include?</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='true true kw'>true</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43:58 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/Row.html b/doc/Axlsx/Row.html new file mode 100644 index 00000000..7c2bee3d --- /dev/null +++ b/doc/Axlsx/Row.html @@ -0,0 +1,771 @@ +<!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::Row + + — 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 (R)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">Row</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::Row + + + +</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::Row</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/workbook/worksheet/row.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 rows and cells is to use Worksheet#add_row +</p> +</div> + </div> + +<p> +A Row is a single row in a worksheet. +</p> + + + </div> +</div> +<div class="tags"> + + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="Worksheet.html#add_row-instance_method" title="Axlsx::Worksheet#add_row (method)">Worksheet#add_row</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="#cells-instance_method" title="#cells (instance method)">- (SimpleTypedList) <strong>cells</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The cells this row holds. +</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 row in the worksheet. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#worksheet-instance_method" title="#worksheet (instance method)">- (Worksheet) <strong>worksheet</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The worksheet this row belongs to. +</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="#add_cell-instance_method" title="#add_cell (instance method)">- (Cell) <strong>add_cell</strong>(value = "", options = {}) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Adds a singel sell to the row based on the data provided and updates the +worksheet’s autofit data. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#initialize-instance_method" title="#initialize (instance method)">- (Row) <strong>initialize</strong>(worksheet, values = [], options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new row. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#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 row. +</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::Row (class)">Row</a></span></tt>) <strong>initialize</strong>(worksheet, values = [], options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new row. New Cell objects are created based on the values, types +and style options. A new cell is created for each item in the values array. +style and types options are applied as follows: +</p> +<pre class="code"> + <span class='If constant id'>If</span> <span class='the identifier id'>the</span> <span class='types identifier id'>types</span> <span class='option identifier id'>option</span> <span class='is identifier id'>is</span> <span class='defined identifier id'>defined</span> <span class='and and kw'>and</span> <span class='is identifier id'>is</span> <span class='a identifier id'>a</span> <span class='symbol identifier id'>symbol</span> <span class='it identifier id'>it</span> <span class='is identifier id'>is</span> <span class='applied identifier id'>applied</span> <span class='to identifier id'>to</span> <span class='all identifier id'>all</span> <span class='the identifier id'>the</span> <span class='cells identifier id'>cells</span> <span class='created identifier id'>created</span><span class='dot token'>.</span> + <span class='If constant id'>If</span> <span class='the identifier id'>the</span> <span class='types identifier id'>types</span> <span class='option identifier id'>option</span> <span class='is identifier id'>is</span> <span class='an identifier id'>an</span> <span class='array identifier id'>array</span><span class='comma token'>,</span> <span class='cell identifier id'>cell</span> <span class='types identifier id'>types</span> <span class='are identifier id'>are</span> <span class='applied identifier id'>applied</span> <span class='by identifier id'>by</span> <span class='index identifier id'>index</span> <span class='for for kw'>for</span> <span class='each identifier id'>each</span> <span class='cell identifier id'>cell</span> + <span class='If constant id'>If</span> <span class='the identifier id'>the</span> <span class='types identifier id'>types</span> <span class='option identifier id'>option</span> <span class='is identifier id'>is</span> <span class='not not kw'>not</span> <span class='set identifier id'>set</span><span class='comma token'>,</span> <span class='the identifier id'>the</span> <span class='cell identifier id'>cell</span> <span class='will identifier id'>will</span> <span class='automatically identifier id'>automatically</span> <span class='determine identifier id'>determine</span> <span class='its identifier id'>its</span> <span class='type identifier id'>type</span><span class='dot token'>.</span> + <span class='If constant id'>If</span> <span class='the identifier id'>the</span> <span class='style identifier id'>style</span> <span class='option identifier id'>option</span> <span class='is identifier id'>is</span> <span class='defined identifier id'>defined</span> <span class='and and kw'>and</span> <span class='is identifier id'>is</span> <span class='an identifier id'>an</span> <span class='Integer constant id'>Integer</span><span class='comma token'>,</span> <span class='it identifier id'>it</span> <span class='is identifier id'>is</span> <span class='applied identifier id'>applied</span> <span class='to identifier id'>to</span> <span class='all identifier id'>all</span> <span class='cells identifier id'>cells</span> <span class='created identifier id'>created</span><span class='dot token'>.</span> + <span class='If constant id'>If</span> <span class='the identifier id'>the</span> <span class='style identifier id'>style</span> <span class='option identifier id'>option</span> <span class='is identifier id'>is</span> <span class='an identifier id'>an</span> <span class='array identifier id'>array</span><span class='comma token'>,</span> <span class='style identifier id'>style</span> <span class='is identifier id'>is</span> <span class='applied identifier id'>applied</span> <span class='by identifier id'>by</span> <span class='index identifier id'>index</span> <span class='for for kw'>for</span> <span class='each identifier id'>each</span> <span class='cell identifier id'>cell</span><span class='dot token'>.</span> + <span class='If constant id'>If</span> <span class='the identifier id'>the</span> <span class='style identifier id'>style</span> <span class='option identifier id'>option</span> <span class='is identifier id'>is</span> <span class='not not kw'>not</span> <span class='defined identifier id'>defined</span><span class='comma token'>,</span> <span class='the identifier id'>the</span> <span class='default identifier id'>default</span> <span class='style identifier id'>style</span> <span class='lparen token'>(</span><span class='integer val'>0</span><span class='rparen token'>)</span> <span class='is identifier id'>is</span> <span class='applied identifier id'>applied</span> <span class='to identifier id'>to</span> <span class='each identifier id'>each</span> <span class='cell identifier id'>cell</span><span class='dot token'>.</span> +</pre> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>worksheet</span> + + + <span class='type'>(<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</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">values</span> + <span class="type">(<tt>Array</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">types</span> + <span class="type">(<tt>Array</tt>, <tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">style</span> + <span class="type">(<tt>Array</tt>, <tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="#array_to_cells-instance_method" title="Axlsx::Row#array_to_cells (method)">#array_to_cells</a></span></li> + + <li><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +33 +34 +35 +36 +37 +38</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 33</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='comma token'>,</span> <span class='values identifier id'>values</span><span class='assign token'>=</span><span class='lbrack token'>[</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='worksheet identifier id'>worksheet</span> <span class='assign token'>=</span> <span class='worksheet identifier id'>worksheet</span> + <span class='@cells ivar id'>@cells</span> <span class='assign token'>=</span> <span class='SimpleTypedList constant id'>SimpleTypedList</span><span class='dot token'>.</span><span class='new identifier id'>new</span> <span class='Cell constant id'>Cell</span> + <span class='@worksheet ivar id'>@worksheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span> <span class='lshft op'><<</span> <span class='self self kw'>self</span> + <span class='array_to_cells identifier id'>array_to_cells</span><span class='lparen token'>(</span><span class='values identifier id'>values</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id=""></span> + <span id="cells-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="cells-instance_method"> + + - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>cells</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The cells this row holds +</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> + +</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/workbook/worksheet/row.rb', line 13</span> + +<span class='def def kw'>def</span> <span class='cells identifier id'>cells</span> + <span class='@cells ivar id'>@cells</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 row in the worksheet +</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"> + + +17 +18 +19</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 17</span> + +<span class='def def kw'>def</span> <span class='index identifier id'>index</span> + <span class='worksheet identifier id'>worksheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="worksheet=-instance_method"></span> + <span id="worksheet-instance_method"></span> + <div class="method_details "> + <p class="signature " id="worksheet-instance_method"> + + - (<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>) <strong>worksheet</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The worksheet this row belongs to +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +9 +10 +11</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 9</span> + +<span class='def def kw'>def</span> <span class='worksheet identifier id'>worksheet</span> + <span class='@worksheet ivar id'>@worksheet</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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="add_cell-instance_method"> + + - (<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>) <strong>add_cell</strong>(value = "", options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Adds a singel sell to the row based on the data provided and updates the +worksheet’s autofit data. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +53 +54 +55 +56 +57</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 53</span> + +<span class='def def kw'>def</span> <span class='add_cell identifier id'>add_cell</span><span class='lparen token'>(</span><span class='value identifier id'>value</span><span class='assign token'>=</span><span class='string val'>""</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='c identifier id'>c</span> <span class='assign token'>=</span> <span class='Cell constant id'>Cell</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='comma token'>,</span> <span class='value identifier id'>value</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='update_auto_fit_data identifier id'>update_auto_fit_data</span> + <span class='c identifier id'>c</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 row +</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"> + + +47 +48 +49</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 47</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='row identifier id'>row</span><span class='lparen token'>(</span><span class='symbol val'>:r</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='index identifier id'>index</span><span class='plus op'>+</span><span class='integer val'>1</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> <span class='@cells ivar id'>@cells</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='cell identifier id'>cell</span><span class='bitor op'>|</span> <span class='cell identifier id'>cell</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:44:01 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/Scaling.html b/doc/Axlsx/Scaling.html new file mode 100644 index 00000000..1e565899 --- /dev/null +++ b/doc/Axlsx/Scaling.html @@ -0,0 +1,740 @@ +<!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::Scaling + + — 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 (S)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">Scaling</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::Scaling + + + +</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::Scaling</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/drawing/scaling.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +The Scaling class defines axis scaling +</p> + + + </div> +</div> +<div class="tags"> + + +</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="#logBase-instance_method" title="#logBase (instance method)">- (Integer) <strong>logBase</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +logarithmic base for a logarithmic axis. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#max-instance_method" title="#max (instance method)">- (Float) <strong>max</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +the maximum scaling. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#min-instance_method" title="#min (instance method)">- (Float) <strong>min</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +the minimu scaling. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#orientation-instance_method" title="#orientation (instance method)">- (Symbol) <strong>orientation</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +the orientation of the axis must be one of [:minMax, :maxMin]. +</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)">- (Scaling) <strong>initialize</strong>(options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +creates a new Scaling object. +</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 axId. +</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::Scaling (class)">Scaling</a></span></tt>) <strong>initialize</strong>(options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +creates a new Scaling object +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <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">logBase</span> + <span class="type">(<tt>Integer</tt>, <tt>Fixnum</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">orientation</span> + <span class="type">(<tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">max</span> + <span class="type">(<tt>Float</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">min</span> + <span class="type">(<tt>Float</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +28 +29 +30 +31 +32 +33</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/scaling.rb', line 28</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='@orientation ivar id'>@orientation</span> <span class='assign token'>=</span> <span class='symbol val'>:minMax</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="logBase=-instance_method"></span> + <span id="logBase-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="logBase-instance_method"> + + - (<tt>Integer</tt>) <strong>logBase</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +logarithmic base for a logarithmic axis. must be between 2 and 1000 +</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"> + + +8 +9 +10</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/scaling.rb', line 8</span> + +<span class='def def kw'>def</span> <span class='logBase identifier id'>logBase</span> + <span class='@logBase ivar id'>@logBase</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="max=-instance_method"></span> + <span id="max-instance_method"></span> + <div class="method_details "> + <p class="signature " id="max-instance_method"> + + - (<tt>Float</tt>) <strong>max</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +the maximum scaling +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Float</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +17 +18 +19</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/scaling.rb', line 17</span> + +<span class='def def kw'>def</span> <span class='max identifier id'>max</span> + <span class='@max ivar id'>@max</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="min=-instance_method"></span> + <span id="min-instance_method"></span> + <div class="method_details "> + <p class="signature " id="min-instance_method"> + + - (<tt>Float</tt>) <strong>min</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +the minimu scaling +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Float</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +21 +22 +23</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/scaling.rb', line 21</span> + +<span class='def def kw'>def</span> <span class='min identifier id'>min</span> + <span class='@min ivar id'>@min</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="orientation=-instance_method"></span> + <span id="orientation-instance_method"></span> + <div class="method_details "> + <p class="signature " id="orientation-instance_method"> + + - (<tt>Symbol</tt>) <strong>orientation</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +the orientation of the axis must be one of [:minMax, :maxMin] +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Symbol</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/scaling.rb', line 13</span> + +<span class='def def kw'>def</span> <span class='orientation identifier id'>orientation</span> + <span class='@orientation ivar id'>@orientation</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 axId +</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"> + + +43 +44 +45 +46 +47 +48 +49 +50</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/scaling.rb', line 43</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:scaling'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:logBase'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span> <span class='@logBase ivar id'>@logBase</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@logBase ivar id'>@logBase</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:orientation'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span> <span class='@orientation ivar id'>@orientation</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@orientation ivar id'>@orientation</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:min'</span><span class='comma token'>,</span> <span class='symbol val'>:val</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='@min ivar id'>@min</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@min ivar id'>@min</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:max'</span><span class='comma token'>,</span> <span class='symbol val'>:val</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='@max ivar id'>@max</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@max ivar id'>@max</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43:56 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/Series.html b/doc/Axlsx/Series.html new file mode 100644 index 00000000..1b698011 --- /dev/null +++ b/doc/Axlsx/Series.html @@ -0,0 +1,750 @@ +<!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::Series + + — 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 (S)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">Series</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::Series + + + +</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::Series</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/drawing/series.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 series is to use Chart#add_series +</p> +</div> + </div> + +<p> +A Series defines the title, data and labels for chart data. +</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="Chart.html#add_series-instance_method" title="Axlsx::Chart#add_series (method)">Chart#add_series</a></span></li> + + </ul> + +</div><div id="subclasses"> + <h2>Direct Known Subclasses</h2> + <p class="children"><span class='object_link'><a href="BarSeries.html" title="Axlsx::BarSeries (class)">BarSeries</a></span>, <span class='object_link'><a href="PieSeries.html" title="Axlsx::PieSeries (class)">PieSeries</a></span></p> +</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="#chart-instance_method" title="#chart (instance method)">- (Chart) <strong>chart</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The chart that owns this series. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#index-instance_method" title="#index (instance method)">- (Object) <strong>index</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +retrieves the series index in the chart’s series collection. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#order-instance_method" title="#order (instance method)">- (Integer) <strong>order</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The order of this series in the chart’s series. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#title-instance_method" title="#title (instance method)">- (String) <strong>title</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The title of the series. +</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)">- (Series) <strong>initialize</strong>(chart, options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new series. +</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 series. +</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::Series (class)">Series</a></span></tt>) <strong>initialize</strong>(chart, options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new series +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>chart</span> + + + <span class='type'>(<tt><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</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">order</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">title</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +28 +29 +30 +31 +32 +33 +34</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/series.rb', line 28</span> + +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='chart identifier id'>chart</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='chart identifier id'>chart</span> <span class='assign token'>=</span> <span class='chart identifier id'>chart</span> + <span class='@chart ivar id'>@chart</span><span class='dot token'>.</span><span class='series identifier id'>series</span> <span class='lshft op'><<</span> <span class='self self kw'>self</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="chart=-instance_method"></span> + <span id="chart-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="chart-instance_method"> + + - (<tt><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></tt>) <strong>chart</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The chart that owns this series +</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"> + + +10 +11 +12</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/series.rb', line 10</span> + +<span class='def def kw'>def</span> <span class='chart identifier id'>chart</span> + <span class='@chart ivar id'>@chart</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="index-instance_method"></span> + <div class="method_details "> + <p class="signature " id="index-instance_method"> + + - (<tt>Object</tt>) <strong>index</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +retrieves the series index in the chart’s series collection +</p> + + + </div> +</div> +<div class="tags"> + + +</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/series.rb', line 14</span> + +<span class='def def kw'>def</span> <span class='index identifier id'>index</span> + <span class='@chart ivar id'>@chart</span><span class='dot token'>.</span><span class='series identifier id'>series</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="order=-instance_method"></span> + <span id="order-instance_method"></span> + <div class="method_details "> + <p class="signature " id="order-instance_method"> + + - (<tt>Integer</tt>) <strong>order</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The order of this series in the chart’s series. +</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"> + + +18 +19 +20</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/series.rb', line 18</span> + +<span class='def def kw'>def</span> <span class='order identifier id'>order</span> + <span class='@order ivar id'>@order</span> <span class='orop op'>||</span> <span class='index identifier id'>index</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="title=-instance_method"></span> + <span id="title-instance_method"></span> + <div class="method_details "> + <p class="signature " id="title-instance_method"> + + - (<tt>String</tt>) <strong>title</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The title of the series +</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"> + + +22 +23 +24</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/series.rb', line 22</span> + +<span class='def def kw'>def</span> <span class='title identifier id'>title</span> + <span class='@title ivar id'>@title</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 series +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>xml</span> + + + <span class='type'>(<tt>Nokogiri::XML::Builder</tt>)</span> + + + + — + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> +</div> + + </li> + +</ul> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +57 +58 +59 +60 +61 +62 +63 +64 +65 +66</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/series.rb', line 57</span> + +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:ser'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:idx'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='index identifier id'>index</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:order'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='order identifier id'>order</span> <span class='orop op'>||</span> <span class='index identifier id'>index</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:tx'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:v'</span><span class='comma token'>,</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='title identifier id'>title</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='yield yield kw'>yield</span> <span class='xml identifier id'>xml</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43: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> + + </body> +</html>
\ No newline at end of file diff --git a/doc/Axlsx/SimpleTypedList.html b/doc/Axlsx/SimpleTypedList.html new file mode 100644 index 00000000..d171532c --- /dev/null +++ b/doc/Axlsx/SimpleTypedList.html @@ -0,0 +1,1617 @@ +<!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::SimpleTypedList + + — 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 (S)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">SimpleTypedList</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::SimpleTypedList + + + +</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::SimpleTypedList</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/util/simple_typed_list.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +A SimpleTypedList is a type restrictive collection that allows some of the +methods from Array and supports basic xml serialization. +</p> + + + </div> +</div> +<div class="tags"> + + +</div><div id="subclasses"> + <h2>Direct Known Subclasses</h2> + <p class="children"><span class='object_link'><a href="ContentType.html" title="Axlsx::ContentType (class)">ContentType</a></span>, <span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span>, <span class='object_link'><a href="TableStyle.html" title="Axlsx::TableStyle (class)">TableStyle</a></span>, <span class='object_link'><a href="TableStyles.html" title="Axlsx::TableStyles (class)">TableStyles</a></span></p> +</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="#allowed_types-instance_method" title="#allowed_types (instance method)">- (Array) <strong>allowed_types</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The class constants of allowed types. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#locked_at-instance_method" title="#locked_at (instance method)">- (Integer) <strong>locked_at</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The index below which items cannot be removed. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#serialize_as-instance_method" title="#serialize_as (instance method)">- (String) <strong>serialize_as</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The tag name to use when serializing this object by default the parent node +for all items in the list is the classname of the first allowed type with +the first letter in lowercase. +</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="#%3C%3C-instance_method" title="#<< (instance method)">- (Integer) <strong><<</strong>(v) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Concat operator. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#%5B%5D%3D-instance_method" title="#[]= (instance method)">- (Object) <strong>[]=</strong>(index, v) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +positional assignment. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#delete-instance_method" title="#delete (instance method)">- (Any) <strong>delete</strong>(v) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +delete the item from the list. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#delete_at-instance_method" title="#delete_at (instance method)">- (Any) <strong>delete_at</strong>(index) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +delete the item from the list at the index position provided. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#initialize-instance_method" title="#initialize (instance method)">- (SimpleTypedList) <strong>initialize</strong>(type, serialize_as = nil) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creats a new typed list. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#lock-instance_method" title="#lock (instance method)">- (self) <strong>lock</strong> </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Lock this list at the current size. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#method_missing-instance_method" title="#method_missing (instance method)">- (Object) <strong>method_missing</strong>(meth, *args, &block) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +method_mission override to pass allowed methods to the list. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#protected%3F-instance_method" title="#protected? (instance method)">- (Boolean) <strong>protected?</strong>(index) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +determines if the index is protected. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#push-instance_method" title="#push (instance method)">- (Object) <strong>push</strong>(v) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +alternate of << method. +</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 list If the serialize_as property is set, it is used as the +parent node name. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#unlock-instance_method" title="#unlock (instance method)">- (self) <strong>unlock</strong> </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Unlock the list. +</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::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>initialize</strong>(type, serialize_as = nil) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creats a new typed list +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>type</span> + + + <span class='type'>(<tt>Array</tt>, <tt>Class</tt>)</span> + + + + — + <div class='inline'><p> +An array of Class objects or a single Class object +</p> +</div> + + </li> + + <li> + + <span class='name'>serialize</span> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +The tag name to use in serialization +</p> +</div> + + </li> + +</ul> + +<h3>Raises:</h3> +<ul class="raise"> + + <li> + + + <span class='type'>(<tt>ArgumentError</tt>)</span> + + + + — + <div class='inline'><p> +if all members of type are not Class objects +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +22 +23 +24 +25 +26 +27 +28 +29 +30 +31 +32 +33</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/simple_typed_list.rb', line 22</span> + +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span> <span class='type identifier id'>type</span><span class='comma token'>,</span> <span class='serialize_as identifier id'>serialize_as</span><span class='assign token'>=</span><span class='nil nil kw'>nil</span> + <span class='if if kw'>if</span> <span class='type identifier id'>type</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span> <span class='Array constant id'>Array</span> + <span class='type identifier id'>type</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='item identifier id'>item</span><span class='bitor op'>|</span> <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='string val'>"All members of type must be Class objects"</span> <span class='unless unless_mod kw'>unless</span> <span class='item identifier id'>item</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span> <span class='Class constant id'>Class</span> <span class='rbrace token'>}</span> + <span class='@allowed_types ivar id'>@allowed_types</span> <span class='assign token'>=</span> <span class='type identifier id'>type</span> + <span class='else else kw'>else</span> + <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='string val'>"Type must be a Class object or array of Class objects"</span> <span class='unless unless_mod kw'>unless</span> <span class='type identifier id'>type</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span> <span class='Class constant id'>Class</span> + <span class='@allowed_types ivar id'>@allowed_types</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='type identifier id'>type</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> + <span class='@list ivar id'>@list</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span> + <span class='@locked_at ivar id'>@locked_at</span> <span class='assign token'>=</span> <span class='nil nil kw'>nil</span> + <span class='@serialize_as ivar id'>@serialize_as</span> <span class='assign token'>=</span> <span class='serialize_as identifier id'>serialize_as</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> +<div id="method_missing_details" class="method_details_list"> + <h2>Dynamic Method Handling</h2> + <p class="notice this"> + This class handles dynamic methods through the <tt>method_missing</tt> method + + </p> + + <div class="method_details first"> + <p class="signature first" id="method_missing-instance_method"> + + - (<tt>Object</tt>) <strong>method_missing</strong>(meth, *args, &block) + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +the following methods are not allowed +</p> +<pre class="code"> + <span class='symbol val'>:replace</span> + <span class='symbol val'>:insert</span> + <span class='symbol val'>:collect!</span> + <span class='symbol val'>:map!</span> + <span class='symbol val'>:pop</span> + <span class='symbol val'>:delete_if</span> + <span class='symbol val'>:reverse!</span> + <span class='symbol val'>:shift</span> + <span class='symbol val'>:shuffle!</span> + <span class='symbol val'>:slice!</span> + <span class='symbol val'>:sort!</span> + <span class='symbol val'>:uniq!</span> + <span class='symbol val'>:unshift</span> + <span class='symbol val'>:zip</span> + <span class='symbol val'>:flatten!</span> + <span class='symbol val'>:fill</span> + <span class='symbol val'>:drop</span> + <span class='symbol val'>:drop_while</span> + <span class='symbol val'>:delete_if</span> + <span class='symbol val'>:clear</span> + <span class='symbol val'>:concat</span> +</pre> +</div> + </div> + +<p> +method_mission override to pass allowed methods to the list. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Raises:</h3> +<ul class="raise"> + + <li> + + + <span class='type'>(<tt>ArgumentError</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +127 +128 +129 +130 +131 +132 +133 +134</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/simple_typed_list.rb', line 127</span> + +<span class='def def kw'>def</span> <span class='method_missing identifier id'>method_missing</span><span class='lparen token'>(</span><span class='meth identifier id'>meth</span><span class='comma token'>,</span> <span class='mult op'>*</span><span class='args identifier id'>args</span><span class='comma token'>,</span> <span class='bitand op'>&</span><span class='block identifier id'>block</span><span class='rparen token'>)</span> + <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='dstring node'>"#{meth} not supported"</span> <span class='if if_mod kw'>if</span> <span class='lbrack token'>[</span><span class='symbol val'>:replace</span><span class='comma token'>,</span> <span class='symbol val'>:insert</span><span class='comma token'>,</span> <span class='symbol val'>:collect!</span><span class='comma token'>,</span> <span class='symbol val'>:map!</span><span class='comma token'>,</span> <span class='symbol val'>:pop</span><span class='comma token'>,</span> <span class='symbol val'>:delete_if</span><span class='comma token'>,</span> <span class='symbol val'>:reverse!</span><span class='comma token'>,</span> <span class='symbol val'>:shift</span><span class='comma token'>,</span> <span class='symbol val'>:shuffle!</span><span class='comma token'>,</span> <span class='symbol val'>:slice!</span><span class='comma token'>,</span> <span class='symbol val'>:sort!</span><span class='comma token'>,</span> <span class='symbol val'>:uniq!</span><span class='comma token'>,</span> <span class='symbol val'>:unshift</span><span class='comma token'>,</span> <span class='symbol val'>:zip</span><span class='comma token'>,</span> <span class='symbol val'>:flatten!</span><span class='comma token'>,</span> <span class='symbol val'>:fill</span><span class='comma token'>,</span> <span class='symbol val'>:drop</span><span class='comma token'>,</span> <span class='symbol val'>:drop_while</span><span class='comma token'>,</span> <span class='symbol val'>:delete_if</span><span class='comma token'>,</span> <span class='symbol val'>:clear</span><span class='comma token'>,</span> <span class='symbol val'>:concat</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='include? fid id'>include?</span> <span class='meth identifier id'>meth</span><span class='dot token'>.</span><span class='to_sym identifier id'>to_sym</span> + <span class='if if kw'>if</span> <span class='@list ivar id'>@list</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='meth identifier id'>meth</span> + <span class='@list ivar id'>@list</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='meth identifier id'>meth</span><span class='comma token'>,</span> <span class='mult op'>*</span><span class='args identifier id'>args</span><span class='comma token'>,</span> <span class='bitand op'>&</span><span class='block identifier id'>block</span><span class='rparen token'>)</span> + <span class='else else kw'>else</span> + <span class='super super kw'>super</span> + <span class='end end kw'>end</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="allowed_types-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="allowed_types-instance_method"> + + - (<tt>Array</tt>) <strong>allowed_types</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The class constants of allowed types +</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"> + + +7 +8 +9</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/simple_typed_list.rb', line 7</span> + +<span class='def def kw'>def</span> <span class='allowed_types identifier id'>allowed_types</span> + <span class='@allowed_types ivar id'>@allowed_types</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="locked_at-instance_method"></span> + <div class="method_details "> + <p class="signature " id="locked_at-instance_method"> + + - (<tt>Integer</tt>) <strong>locked_at</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The index below which items cannot be removed +</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"> + + +11 +12 +13</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/simple_typed_list.rb', line 11</span> + +<span class='def def kw'>def</span> <span class='locked_at identifier id'>locked_at</span> + <span class='@locked_at ivar id'>@locked_at</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="serialize_as-instance_method"></span> + <div class="method_details "> + <p class="signature " id="serialize_as-instance_method"> + + - (<tt>String</tt>) <strong>serialize_as</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The tag name to use when serializing this object by default the parent node +for all items in the list is the classname of the first allowed type with +the first letter in lowercase. +</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"> + + +16 +17 +18</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/simple_typed_list.rb', line 16</span> + +<span class='def def kw'>def</span> <span class='serialize_as identifier id'>serialize_as</span> + <span class='@serialize_as ivar id'>@serialize_as</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="<<-instance_method"> + + - (<tt>Integer</tt>) <strong><<</strong>(v) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Concat operator +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>v</span> + + + <span class='type'>(<tt>Any</tt>)</span> + + + + — + <div class='inline'><p> +the data to be added +</p> +</div> + + </li> + +</ul> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +returns the index of the item added. +</p> +</div> + + </li> + +</ul> +<h3>Raises:</h3> +<ul class="raise"> + + <li> + + + <span class='type'>(<tt>ArgumentError</tt>)</span> + + + + — + <div class='inline'><p> +if the value being added is not one fo the allowed types +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +53 +54 +55 +56 +57</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/simple_typed_list.rb', line 53</span> + +<span class='def def kw'>def</span> <span class='lshft op'><<</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='DataTypeValidator constant id'>DataTypeValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='string val'>"SimpleTypedList.<<"</span><span class='comma token'>,</span> <span class='@allowed_types ivar id'>@allowed_types</span><span class='comma token'>,</span> <span class='v identifier id'>v</span> + <span class='@list ivar id'>@list</span> <span class='lshft op'><<</span> <span class='v identifier id'>v</span> + <span class='@list ivar id'>@list</span><span class='dot token'>.</span><span class='size identifier id'>size</span> <span class='minus op'>-</span> <span class='integer val'>1</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="[]=-instance_method"> + + - (<tt>Object</tt>) <strong>[]=</strong>(index, v) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +positional assignment. Adds the item at the index specified +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>index</span> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + </li> + + <li> + + <span class='name'>v</span> + + + <span class='type'>(<tt>Any</tt>)</span> + + + + </li> + +</ul> + +<h3>Raises:</h3> +<ul class="raise"> + + <li> + + + <span class='type'>(<tt>ArgumentError</tt>)</span> + + + + — + <div class='inline'><p> +if the index is protected by locking +</p> +</div> + + </li> + + <li> + + + <span class='type'>(<tt>ArgumentError</tt>)</span> + + + + — + <div class='inline'><p> +if the item is not one of the allowed types +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +89 +90 +91 +92 +93 +94</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/simple_typed_list.rb', line 89</span> + +<span class='def def kw'>def</span> <span class='aset op'>[]=</span><span class='lparen token'>(</span><span class='index identifier id'>index</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='DataTypeValidator constant id'>DataTypeValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='string val'>"SimpleTypedList.<<"</span><span class='comma token'>,</span> <span class='@allowed_types ivar id'>@allowed_types</span><span class='comma token'>,</span> <span class='v identifier id'>v</span> + <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='string val'>"Item is protected and cannot be changed"</span> <span class='if if_mod kw'>if</span> <span class='protected? fid id'>protected?</span> <span class='index identifier id'>index</span> + <span class='@list ivar id'>@list</span><span class='lbrack token'>[</span><span class='index identifier id'>index</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='v identifier id'>v</span> + <span class='v identifier id'>v</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="delete-instance_method"> + + - (<tt>Any</tt>) <strong>delete</strong>(v) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +delete the item from the list +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>v</span> + + + <span class='type'>(<tt>Any</tt>)</span> + + + + — + <div class='inline'><p> +The item to be deleted. +</p> +</div> + + </li> + +</ul> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Any</tt>)</span> + + + + — + <div class='inline'><p> +The item deleted +</p> +</div> + + </li> + +</ul> +<h3>Raises:</h3> +<ul class="raise"> + + <li> + + + <span class='type'>(<tt>ArgumentError</tt>)</span> + + + + — + <div class='inline'><p> +if the item’s index is protected by locking +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +69 +70 +71 +72 +73</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/simple_typed_list.rb', line 69</span> + +<span class='def def kw'>def</span> <span class='delete identifier id'>delete</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='return return kw'>return</span> <span class='unless unless_mod kw'>unless</span> <span class='@list ivar id'>@list</span><span class='dot token'>.</span><span class='include? fid id'>include?</span> <span class='v identifier id'>v</span> + <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='string val'>"Item is protected and cannot be deleted"</span> <span class='if if_mod kw'>if</span> <span class='protected? fid id'>protected?</span> <span class='@list ivar id'>@list</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='@list ivar id'>@list</span><span class='dot token'>.</span><span class='delete identifier id'>delete</span> <span class='v identifier id'>v</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="delete_at-instance_method"> + + - (<tt>Any</tt>) <strong>delete_at</strong>(index) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +delete the item from the list at the index position provided +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Any</tt>)</span> + + + + — + <div class='inline'><p> +The item deleted +</p> +</div> + + </li> + +</ul> +<h3>Raises:</h3> +<ul class="raise"> + + <li> + + + <span class='type'>(<tt>ArgumentError</tt>)</span> + + + + — + <div class='inline'><p> +if the index is protected by locking +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +78 +79 +80 +81 +82</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/simple_typed_list.rb', line 78</span> + +<span class='def def kw'>def</span> <span class='delete_at identifier id'>delete_at</span><span class='lparen token'>(</span><span class='index identifier id'>index</span><span class='rparen token'>)</span> + <span class='@list ivar id'>@list</span><span class='lbrack token'>[</span><span class='index identifier id'>index</span><span class='rbrack token'>]</span> + <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='string val'>"Item is protected and cannot be deleted"</span> <span class='if if_mod kw'>if</span> <span class='protected? fid id'>protected?</span> <span class='index identifier id'>index</span> + <span class='@list ivar id'>@list</span><span class='dot token'>.</span><span class='delete_at identifier id'>delete_at</span> <span class='index identifier id'>index</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="lock-instance_method"> + + - (<tt>self</tt>) <strong>lock</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Lock this list at the current size +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>self</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +37 +38 +39 +40</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/simple_typed_list.rb', line 37</span> + +<span class='def def kw'>def</span> <span class='lock identifier id'>lock</span> + <span class='@locked_at ivar id'>@locked_at</span> <span class='assign token'>=</span> <span class='@list ivar id'>@list</span><span class='dot token'>.</span><span class='size identifier id'>size</span> + <span class='self self kw'>self</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="protected?-instance_method"> + + - (<tt>Boolean</tt>) <strong>protected?</strong>(index) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +determines if the index is protected +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>index</span> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + </li> + +</ul> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +98 +99 +100 +101</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/simple_typed_list.rb', line 98</span> + +<span class='def def kw'>def</span> <span class='protected? fid id'>protected?</span> <span class='index identifier id'>index</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='@locked_at ivar id'>@locked_at</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span> <span class='Fixnum constant id'>Fixnum</span> + <span class='index identifier id'>index</span> <span class='lt op'><</span> <span class='@locked_at ivar id'>@locked_at</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="push-instance_method"> + + - (<tt>Object</tt>) <strong>push</strong>(v) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +alternate of << method +</p> + + + </div> +</div> +<div class="tags"> + + + <h3>See Also:</h3> + <ul class="see"> + + <li><<</li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +61 +62 +63</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/simple_typed_list.rb', line 61</span> + +<span class='def def kw'>def</span> <span class='push identifier id'>push</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='lshft op'><<</span> <span class='v identifier id'>v</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="to_xml-instance_method"> + + - (<tt>String</tt>) <strong>to_xml</strong>(xml) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Serializes the list If the serialize_as property is set, it is used as the +parent node name. If the serialize_as property is nil, the first item in +the list of allowed_types will be used, having the first letter of the +class changed to lower case. +</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"> + + +141 +142 +143 +144 +145 +146 +147</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/simple_typed_list.rb', line 141</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='classname identifier id'>classname</span> <span class='assign token'>=</span> <span class='@allowed_types ivar id'>@allowed_types</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='name identifier id'>name</span><span class='dot token'>.</span><span class='split identifier id'>split</span><span class='lparen token'>(</span><span class='string val'>'::'</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='last identifier id'>last</span> + <span class='el_name identifier id'>el_name</span> <span class='assign token'>=</span> <span class='serialize_as identifier id'>serialize_as</span> <span class='orop op'>||</span> <span class='lparen token'>(</span><span class='classname identifier id'>classname</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='downcase identifier id'>downcase</span> <span class='plus op'>+</span> <span class='classname identifier id'>classname</span><span class='lbrack token'>[</span><span class='float val'>1</span><span class='dot2 op'>..</span><span class='integer val'>-1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='pluralize identifier id'>pluralize</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='el_name identifier id'>el_name</span><span class='comma token'>,</span> <span class='symbol val'>:count=</span><span class='gt op'>></span><span class='@list ivar id'>@list</span><span class='dot token'>.</span><span class='size identifier id'>size</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='@list ivar id'>@list</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='item identifier id'>item</span><span class='bitor op'>|</span> <span class='item identifier id'>item</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="unlock-instance_method"> + + - (<tt>self</tt>) <strong>unlock</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Unlock the list +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>self</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +44 +45 +46 +47</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/simple_typed_list.rb', line 44</span> + +<span class='def def kw'>def</span> <span class='unlock identifier id'>unlock</span> + <span class='@locked_at ivar id'>@locked_at</span> <span class='assign token'>=</span> <span class='nil nil kw'>nil</span> + <span class='self self kw'>self</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:44:03 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/Styles.html b/doc/Axlsx/Styles.html new file mode 100644 index 00000000..4182db05 --- /dev/null +++ b/doc/Axlsx/Styles.html @@ -0,0 +1,1754 @@ +<!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::Styles + + — 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 (S)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">Styles</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::Styles + + + +</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::Styles</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/stylesheet/styles.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 styles is with add_style +</p> +</div> + </div> + +<p> +The Styles class manages worksheet styles In addition to creating the +require style objects for a valid xlsx package, this class provides the key +mechanism for adding styles to your workbook, and safely applying them to +the cells of your worksheet. All portions of the stylesheet are implemented +here exception colors, which specify legacy and modified pallete colors, +and exLst, whic is used as a future feature data storage area. +</p> + + + </div> +</div> +<div class="tags"> + + + <h3>See Also:</h3> + <ul class="see"> + + <li>Open XML Part 1 18.8.11 for gory details on how this stuff gets put together</li> + + <li><span class='object_link'><a href="#add_style-instance_method" title="Axlsx::Styles#add_style (method)">#add_style</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="#borders-instance_method" title="#borders (instance method)">- (SimpleTypedList) <strong>borders</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The collection of borders used in this workbook Axlsx predefines +THIN_BORDER which can be used to put a border around all of your cells. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#cellStyles-instance_method" title="#cellStyles (instance method)">- (SimpleTypedList) <strong>cellStyles</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The collection of named styles, referencing cellStyleXfs items in the +workbook. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#cellStyleXfs-instance_method" title="#cellStyleXfs (instance method)">- (SimpleTypedList) <strong>cellStyleXfs</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The collection of master formatting records for named cell styles, which +means records defined in cellStyles, in the workbook. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#cellXfs-instance_method" title="#cellXfs (instance method)">- (SimpleTypedList) <strong>cellXfs</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The collection of master formatting records. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#dxfs-instance_method" title="#dxfs (instance method)">- (SimpleTypedList) <strong>dxfs</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The collection of non-cell formatting records used in the worksheet. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#fills-instance_method" title="#fills (instance method)">- (SimpleTypedList) <strong>fills</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The collection of fills used in this workbook. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#fonts-instance_method" title="#fonts (instance method)">- (SimpleTypedList) <strong>fonts</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The collection of fonts used in this workbook. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#numFmts-instance_method" title="#numFmts (instance method)">- (SimpleTypedList) <strong>numFmts</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +numFmts for your styles. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#tableStyles-instance_method" title="#tableStyles (instance method)">- (SimpleTypedList) <strong>tableStyles</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The collection of table styles that will be available to the user in the +excel UI. +</p> +</div></span> + +</li> + + + </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="#add_style-instance_method" title="#add_style (instance method)">- (Integer) <strong>add_style</strong>(options = {}) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Drastically simplifies style creation and management. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#initialize-instance_method" title="#initialize (instance method)">- (Styles) <strong>initialize</strong> </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new Styles object and prepopulates it with the requires objects +to generate a valid package style part. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#to_xml-instance_method" title="#to_xml (instance method)">- (String) <strong>to_xml</strong> </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Serializes the styles document. +</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::Styles (class)">Styles</a></span></tt>) <strong>initialize</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new Styles object and prepopulates it with the requires objects +to generate a valid package style part. +</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +118 +119 +120</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 118</span> + +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rparen token'>)</span> + <span class='load_default_styles identifier id'>load_default_styles</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id=""></span> + <span id="borders-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="borders-instance_method"> + + - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>borders</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 styles is with add_style +</p> +</div> + </div> + +<p> +The collection of borders used in this workbook Axlsx predefines +THIN_BORDER which can be used to put a border around all of your cells. +</p> + + + </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="#add_style-instance_method" title="Axlsx::Styles#add_style (method)">#add_style</a></span></li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +85 +86 +87</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 85</span> + +<span class='def def kw'>def</span> <span class='borders identifier id'>borders</span> + <span class='@borders ivar id'>@borders</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="cellStyles-instance_method"></span> + <div class="method_details "> + <p class="signature " id="cellStyles-instance_method"> + + - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>cellStyles</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 styles is with add_style +</p> +</div> + </div> + +<p> +The collection of named styles, referencing cellStyleXfs items in the +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="#add_style-instance_method" title="Axlsx::Styles#add_style (method)">#add_style</a></span></li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +97 +98 +99</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 97</span> + +<span class='def def kw'>def</span> <span class='cellStyles identifier id'>cellStyles</span> + <span class='@cellStyles ivar id'>@cellStyles</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="cellStyleXfs-instance_method"></span> + <div class="method_details "> + <p class="signature " id="cellStyleXfs-instance_method"> + + - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>cellStyleXfs</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 styles is with add_style +</p> +</div> + </div> + +<p> +The collection of master formatting records for named cell styles, which +means records defined in cellStyles, in the workbook +</p> + + + </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="#add_style-instance_method" title="Axlsx::Styles#add_style (method)">#add_style</a></span></li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +91 +92 +93</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 91</span> + +<span class='def def kw'>def</span> <span class='cellStyleXfs identifier id'>cellStyleXfs</span> + <span class='@cellStyleXfs ivar id'>@cellStyleXfs</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="cellXfs-instance_method"></span> + <div class="method_details "> + <p class="signature " id="cellXfs-instance_method"> + + - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>cellXfs</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 styles is with add_style +</p> +</div> + </div> + +<p> +The collection of master formatting records. This is the list that you will +actually use in styling a workbook. +</p> + + + </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="#add_style-instance_method" title="Axlsx::Styles#add_style (method)">#add_style</a></span></li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +103 +104 +105</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 103</span> + +<span class='def def kw'>def</span> <span class='cellXfs identifier id'>cellXfs</span> + <span class='@cellXfs ivar id'>@cellXfs</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="dxfs-instance_method"></span> + <div class="method_details "> + <p class="signature " id="dxfs-instance_method"> + + - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>dxfs</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 styles is with add_style +</p> +</div> + </div> + +<p> +The collection of non-cell formatting records used in the worksheet. +</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="#add_style-instance_method" title="Axlsx::Styles#add_style (method)">#add_style</a></span></li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +109 +110 +111</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 109</span> + +<span class='def def kw'>def</span> <span class='dxfs identifier id'>dxfs</span> + <span class='@dxfs ivar id'>@dxfs</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="fills-instance_method"></span> + <div class="method_details "> + <p class="signature " id="fills-instance_method"> + + - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>fills</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 styles is with add_style +</p> +</div> + </div> + +<p> +The collection of fills used in 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="#add_style-instance_method" title="Axlsx::Styles#add_style (method)">#add_style</a></span></li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +78 +79 +80</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 78</span> + +<span class='def def kw'>def</span> <span class='fills identifier id'>fills</span> + <span class='@fills ivar id'>@fills</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="fonts-instance_method"></span> + <div class="method_details "> + <p class="signature " id="fonts-instance_method"> + + - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>fonts</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 styles is with add_style +</p> +</div> + </div> + +<p> +The collection of fonts used in 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="#add_style-instance_method" title="Axlsx::Styles#add_style (method)">#add_style</a></span></li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +72 +73 +74</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 72</span> + +<span class='def def kw'>def</span> <span class='fonts identifier id'>fonts</span> + <span class='@fonts ivar id'>@fonts</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="numFmts-instance_method"></span> + <div class="method_details "> + <p class="signature " id="numFmts-instance_method"> + + - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>numFmts</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 styles is with add_style +</p> +</div> + </div> + +<p> +numFmts for your styles. +</p> +<pre class="code"> + <span class='The constant id'>The</span> <span class='default identifier id'>default</span> <span class='styles identifier id'>styles</span><span class='comma token'>,</span> <span class='which identifier id'>which</span> <span class='change identifier id'>change</span> <span class='based identifier id'>based</span> <span class='on identifier id'>on</span> <span class='the identifier id'>the</span> <span class='system identifier id'>system</span> <span class='local identifier id'>local</span><span class='comma token'>,</span> <span class='are identifier id'>are</span> <span class='as identifier id'>as</span> <span class='follows identifier id'>follows</span><span class='dot token'>.</span> + <span class='id identifier id'>id</span> <span class='formatCode identifier id'>formatCode</span> + <span class='integer val'>0</span> <span class='General constant id'>General</span> + <span class='integer val'>1</span> <span class='integer val'>0</span> + <span class='integer val'>2</span> <span class='integer val'>0</span><span class='integer val'>.00</span> + <span class='integer val'>3</span> <span class='comment val'>#,##0</span> + <span class='integer val'>4</span> <span class='comment val'>#,##0.00</span> + <span class='integer val'>9</span> <span class='integer val'>0</span><span class='mod op'>%</span> + <span class='integer val'>10</span> <span class='integer val'>0</span><span class='integer val'>.00</span><span class='mod op'>%</span> + <span class='integer val'>11</span> <span class='integer val'>0</span><span class='float val'>.00E+00</span> + <span class='integer val'>12</span> <span class='comment val'># ?/?</span> + <span class='integer val'>13</span> <span class='comment val'># ??/??</span> + <span class='integer val'>14</span> <span class='mm identifier id'>mm</span><span class='minus op'>-</span><span class='dd identifier id'>dd</span><span class='minus op'>-</span><span class='yy identifier id'>yy</span> + <span class='integer val'>15</span> <span class='d identifier id'>d</span><span class='minus op'>-</span><span class='mmm identifier id'>mmm</span><span class='minus op'>-</span><span class='yy identifier id'>yy</span> + <span class='integer val'>16</span> <span class='d identifier id'>d</span><span class='minus op'>-</span><span class='mmm identifier id'>mmm</span> + <span class='integer val'>17</span> <span class='mmm identifier id'>mmm</span><span class='minus op'>-</span><span class='yy identifier id'>yy</span> + <span class='integer val'>18</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span> <span class='AM constant id'>AM</span><span class='div op'>/</span><span class='PM constant id'>PM</span> + <span class='integer val'>19</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span><span class='symbol val'>:ss</span> <span class='AM constant id'>AM</span><span class='div op'>/</span><span class='PM constant id'>PM</span> + <span class='integer val'>20</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span> + <span class='integer val'>21</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span><span class='symbol val'>:ss</span> + <span class='integer val'>22</span> <span class='m identifier id'>m</span><span class='div op'>/</span><span class='d identifier id'>d</span><span class='div op'>/</span><span class='yy identifier id'>yy</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span> + <span class='integer val'>37</span> <span class='comment val'>#,##0 ;(#,##0)</span> + <span class='integer val'>38</span> <span class='comment val'>#,##0 ;[Red](#,##0)</span> + <span class='integer val'>39</span> <span class='comment val'>#,##0.00;(#,##0.00)</span> + <span class='integer val'>40</span> <span class='comment val'>#,##0.00;[Red](#,##0.00)</span> + <span class='integer val'>45</span> <span class='mm identifier id'>mm</span><span class='symbol val'>:ss</span> + <span class='integer val'>46</span> <span class='lbrack token'>[</span><span class='h identifier id'>h</span><span class='rbrack token'>]</span><span class='symbol val'>:mm</span><span class='symbol val'>:ss</span> + <span class='integer val'>47</span> <span class='mmss identifier id'>mmss</span><span class='integer val'>.0</span> + <span class='integer val'>48</span> <span class='comment val'>##0.0E+0</span> + <span class='integer val'>49</span> @ + <span class='Axlsx constant id'>Axlsx</span> <span class='also identifier id'>also</span> <span class='defines identifier id'>defines</span> <span class='the identifier id'>the</span> <span class='following identifier id'>following</span> <span class='constants identifier id'>constants</span> <span class='which identifier id'>which</span> <span class='you identifier id'>you</span> <span class='can identifier id'>can</span> <span class='use identifier id'>use</span> <span class='in in kw'>in</span> <span class='add_style identifier id'>add_style</span><span class='dot token'>.</span> + <span class='NUM_FMT_PERCENT constant id'>NUM_FMT_PERCENT</span> <span class='formats identifier id'>formats</span> <span class='to identifier id'>to</span> <span class='string val'>"0%"</span> + <span class='NUM_FMT_YYYYMMDD constant id'>NUM_FMT_YYYYMMDD</span> <span class='formats identifier id'>formats</span> <span class='to identifier id'>to</span> <span class='string val'>"yyyy/mm/dd"</span> + <span class='NUM_FMT_YYYYMMDDHHMMSS constant id'>NUM_FMT_YYYYMMDDHHMMSS</span> <span class='formats identifier id'>formats</span> <span class='to identifier id'>to</span> <span class='string val'>"yyyy/mm/dd hh:mm:ss"</span> +</pre> + + + </div> +</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>Open XML Part 1 - 18.8.31 for more information on creating number formats</li> + + <li><span class='object_link'><a href="#add_style-instance_method" title="Axlsx::Styles#add_style (method)">#add_style</a></span></li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +66 +67 +68</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 66</span> + +<span class='def def kw'>def</span> <span class='numFmts identifier id'>numFmts</span> + <span class='@numFmts ivar id'>@numFmts</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="tableStyles-instance_method"></span> + <div class="method_details "> + <p class="signature " id="tableStyles-instance_method"> + + - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>tableStyles</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 styles is with add_style +</p> +</div> + </div> + +<p> +The collection of table styles that will be available to the user in the +excel UI +</p> + + + </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="#add_style-instance_method" title="Axlsx::Styles#add_style (method)">#add_style</a></span></li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +115 +116 +117</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 115</span> + +<span class='def def kw'>def</span> <span class='tableStyles identifier id'>tableStyles</span> + <span class='@tableStyles ivar id'>@tableStyles</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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="add_style-instance_method"> + + - (<tt>Integer</tt>) <strong>add_style</strong>(options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Drastically simplifies style creation and management. +</p> + + + </div> +</div> +<div class="tags"> + + <div class="examples"> + <h3>Examples:</h3> + + <h4><div class='inline'><p> +You Got Style +</p> +</div></h4> + <pre class="example code"><span class='require identifier id'>require</span> <span class='string val'>"rubygems"</span> <span class='comment val'># if that is your preferred way to manage gems!</span> +<span class='require identifier id'>require</span> <span class='string val'>"axlsx"</span> + +<span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> +<span class='ws identifier id'>ws</span> <span class='assign token'>=</span> <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> + +<span class='comment val'># black text on a white background at 14pt with thin borders!</span> +<span class='title identifier id'>title</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='style identifier id'>style</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span><span class='lparen token'>(</span><span class='symbol val'>:bg_color</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"FFFF0000"</span><span class='comma token'>,</span> <span class='symbol val'>:fg_color=</span><span class='gt op'>></span><span class='string val'>"#FF000000"</span><span class='comma token'>,</span> <span class='symbol val'>:sz=</span><span class='gt op'>></span><span class='integer val'>14</span><span class='comma token'>,</span> <span class='symbol val'>:border=</span><span class='gt op'>></span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span> + +<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Least Popular Pets"</span><span class='rbrack token'>]</span> +<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>""</span><span class='comma token'>,</span> <span class='string val'>"Dry Skinned Reptiles"</span><span class='comma token'>,</span> <span class='string val'>"Bald Cats"</span><span class='comma token'>,</span> <span class='string val'>"Violent Parrots"</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='title identifier id'>title</span> +<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Votes"</span><span class='comma token'>,</span> <span class='integer val'>6</span><span class='comma token'>,</span> <span class='integer val'>4</span><span class='comma token'>,</span> <span class='integer val'>1</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span> +<span class='f identifier id'>f</span> <span class='assign token'>=</span> <span class='File constant id'>File</span><span class='dot token'>.</span><span class='open identifier id'>open</span><span class='lparen token'>(</span><span class='string val'>'example_you_got_style.xlsx'</span><span class='comma token'>,</span> <span class='string val'>'w'</span><span class='rparen token'>)</span> +<span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='f identifier id'>f</span><span class='rparen token'>)</span> +</pre> + + <h4><div class='inline'><p> +Styling specifically +</p> +</div></h4> + <pre class="example code"><span class='comment val'># an example of applying specific styles to specific cells</span> +<span class='require identifier id'>require</span> <span class='string val'>"rubygems"</span> <span class='comment val'># if that is your preferred way to manage gems!</span> +<span class='require identifier id'>require</span> <span class='string val'>"axlsx"</span> + +<span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> +<span class='ws identifier id'>ws</span> <span class='assign token'>=</span> <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> + +<span class='comment val'># define your styles</span> +<span class='title identifier id'>title</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='style identifier id'>style</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span><span class='lparen token'>(</span><span class='symbol val'>:bg_color</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"FFFF0000"</span><span class='comma token'>,</span> + <span class='symbol val'>:fg_color=</span><span class='gt op'>></span><span class='string val'>"#FF000000"</span><span class='comma token'>,</span> + <span class='symbol val'>:border=</span><span class='gt op'>></span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span><span class='comma token'>,</span> + <span class='symbol val'>:alignment=</span><span class='gt op'>></span><span class='lbrace token'>{</span><span class='symbol val'>:horizontal</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='symbol val'>:center</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + +<span class='date_time identifier id'>date_time</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='style identifier id'>style</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span><span class='lparen token'>(</span><span class='symbol val'>:num_fmt</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='NUM_FMT_YYYYMMDDHHMMSS constant id'>NUM_FMT_YYYYMMDDHHMMSS</span><span class='comma token'>,</span> + <span class='symbol val'>:border=</span><span class='gt op'>></span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span><span class='rparen token'>)</span> + +<span class='percent identifier id'>percent</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='style identifier id'>style</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span><span class='lparen token'>(</span><span class='symbol val'>:num_fmt</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='NUM_FMT_PERCENT constant id'>NUM_FMT_PERCENT</span><span class='comma token'>,</span> + <span class='symbol val'>:border=</span><span class='gt op'>></span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span><span class='rparen token'>)</span> + +<span class='currency identifier id'>currency</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='style identifier id'>style</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span><span class='lparen token'>(</span><span class='symbol val'>:format_code=</span><span class='gt op'>></span><span class='string val'>"¥#,##0;[Red]¥-#,##0"</span><span class='comma token'>,</span> + <span class='symbol val'>:border=</span><span class='gt op'>></span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span><span class='rparen token'>)</span> + +<span class='comment val'># build your rows</span> +<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Genreated At:"</span><span class='comma token'>,</span> <span class='Time constant id'>Time</span><span class='dot token'>.</span><span class='now identifier id'>now</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:styles=</span><span class='gt op'>></span><span class='lbrack token'>[</span><span class='nil nil kw'>nil</span><span class='comma token'>,</span> <span class='date_time identifier id'>date_time</span><span class='rbrack token'>]</span> +<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Previous Year Quarterly Profits (JPY)"</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='title identifier id'>title</span> +<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Quarter"</span><span class='comma token'>,</span> <span class='string val'>"Profit"</span><span class='comma token'>,</span> <span class='string val'>"% of Total"</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='title identifier id'>title</span> +<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Q1"</span><span class='comma token'>,</span> <span class='integer val'>4000</span><span class='comma token'>,</span> <span class='integer val'>40</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='lbrack token'>[</span><span class='title identifier id'>title</span><span class='comma token'>,</span> <span class='currency identifier id'>currency</span><span class='comma token'>,</span> <span class='percent identifier id'>percent</span><span class='rbrack token'>]</span> +<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Q2"</span><span class='comma token'>,</span> <span class='integer val'>3000</span><span class='comma token'>,</span> <span class='integer val'>30</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='lbrack token'>[</span><span class='title identifier id'>title</span><span class='comma token'>,</span> <span class='currency identifier id'>currency</span><span class='comma token'>,</span> <span class='percent identifier id'>percent</span><span class='rbrack token'>]</span> +<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Q3"</span><span class='comma token'>,</span> <span class='integer val'>1000</span><span class='comma token'>,</span> <span class='integer val'>10</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='lbrack token'>[</span><span class='title identifier id'>title</span><span class='comma token'>,</span> <span class='currency identifier id'>currency</span><span class='comma token'>,</span> <span class='percent identifier id'>percent</span><span class='rbrack token'>]</span> +<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Q4"</span><span class='comma token'>,</span> <span class='integer val'>2000</span><span class='comma token'>,</span> <span class='integer val'>20</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='lbrack token'>[</span><span class='title identifier id'>title</span><span class='comma token'>,</span> <span class='currency identifier id'>currency</span><span class='comma token'>,</span> <span class='percent identifier id'>percent</span><span class='rbrack token'>]</span> +<span class='f identifier id'>f</span> <span class='assign token'>=</span> <span class='File constant id'>File</span><span class='dot token'>.</span><span class='open identifier id'>open</span><span class='lparen token'>(</span><span class='string val'>'example_you_got_style.xlsx'</span><span class='comma token'>,</span> <span class='string val'>'w'</span><span class='rparen token'>)</span> +<span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='f identifier id'>f</span><span class='rparen token'>)</span> +</pre> + + </div> +<h3>Parameters:</h3> +<ul class="param"> + + <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">fg_color</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + — <div class='inline'><p> +The text color +</p> +</div> + </li> + + <li> + <span class="name">sz</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + — <div class='inline'><p> +The text size +</p> +</div> + </li> + + <li> + <span class="name">b</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + — <div class='inline'><p> +Indicates if the text should be bold +</p> +</div> + </li> + + <li> + <span class="name">i</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + — <div class='inline'><p> +Indicates if the text should be italicised +</p> +</div> + </li> + + <li> + <span class="name">strike</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + — <div class='inline'><p> +Indicates if the text should be rendered with a strikethrough +</p> +</div> + </li> + + <li> + <span class="name">strike</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + — <div class='inline'><p> +Indicates if the text should be rendered with a shadow +</p> +</div> + </li> + + <li> + <span class="name">charset</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + — <div class='inline'><p> +The character set to use. +</p> +</div> + </li> + + <li> + <span class="name">family</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + — <div class='inline'><p> +The font family to use. +</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 of the font to use +</p> +</div> + </li> + + <li> + <span class="name">num_fmt</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + — <div class='inline'><p> +The number format to apply +</p> +</div> + </li> + + <li> + <span class="name">format_code</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + — <div class='inline'><p> +The formatting to apply. If this is specified, num_fmt is ignored. +</p> +</div> + </li> + + <li> + <span class="name">border</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + — <div class='inline'><p> +The border style to use. +</p> +</div> + </li> + + <li> + <span class="name">bg_color</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + — <div class='inline'><p> +The background color to apply to the cell +</p> +</div> + </li> + + <li> + <span class="name">hidden</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + — <div class='inline'><p> +Indicates if the cell should be hidden +</p> +</div> + </li> + + <li> + <span class="name">locked</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + — <div class='inline'><p> +Indicates if the cell should be locked +</p> +</div> + </li> + + <li> + <span class="name">alignment</span> + <span class="type">(<tt>Hash</tt>)</span> + <span class="default"> + + </span> + — <div class='inline'><p> +A hash defining any of the attributes used in CellAlignment +</p> +</div> + </li> + + </ul> + + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + </li> + +</ul> +<h3>Raises:</h3> +<ul class="raise"> + + <li> + + + <span class='type'>(<tt>ArgumentError</tt>)</span> + + + + </li> + +</ul> + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="CellAlignment.html" title="Axlsx::CellAlignment (class)">CellAlignment</a></span></li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +191 +192 +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215 +216 +217 +218 +219 +220 +221 +222 +223 +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 191</span> + +<span class='def def kw'>def</span> <span class='add_style identifier id'>add_style</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + + <span class='numFmtId identifier id'>numFmtId</span> <span class='assign token'>=</span> <span class='if if kw'>if</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:format_code</span><span class='rbrack token'>]</span> + <span class='n identifier id'>n</span> <span class='assign token'>=</span> <span class='@numFmts ivar id'>@numFmts</span><span class='dot token'>.</span><span class='map identifier id'>map</span><span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='f identifier id'>f</span><span class='bitor op'>|</span> <span class='f identifier id'>f</span><span class='dot token'>.</span><span class='numFmtId identifier id'>numFmtId</span> <span class='rbrace token'>}</span><span class='dot token'>.</span><span class='max identifier id'>max</span> <span class='plus op'>+</span> <span class='integer val'>1</span> + <span class='numFmts identifier id'>numFmts</span> <span class='lshft op'><<</span> <span class='NumFmt constant id'>NumFmt</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:numFmtId</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='n identifier id'>n</span><span class='comma token'>,</span> <span class='symbol val'>:formatCode=</span><span class='gt op'>></span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:format_code</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> + <span class='n identifier id'>n</span> + <span class='else else kw'>else</span> + <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:num_fmt</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='integer val'>0</span> + <span class='end end kw'>end</span> + + <span class='borderId identifier id'>borderId</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:border</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='integer val'>0</span> + <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='string val'>"Invalid borderId"</span> <span class='unless unless_mod kw'>unless</span> <span class='borderId identifier id'>borderId</span> <span class='lt op'><</span> <span class='borders identifier id'>borders</span><span class='dot token'>.</span><span class='size identifier id'>size</span> + + <span class='fill identifier id'>fill</span> <span class='assign token'>=</span> <span class='if if kw'>if</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:bg_color</span><span class='rbrack token'>]</span> + <span class='color identifier id'>color</span> <span class='assign token'>=</span> <span class='Color constant id'>Color</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:rgb=</span><span class='gt op'>></span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:bg_color</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> + <span class='pattern identifier id'>pattern</span> <span class='assign token'>=</span> <span class='PatternFill constant id'>PatternFill</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:patternType</span> <span class='assign token'>=</span><span class='gt op'>></span><span class='symbol val'>:solid</span><span class='comma token'>,</span> <span class='symbol val'>:fgColor=</span><span class='gt op'>></span><span class='color identifier id'>color</span><span class='rparen token'>)</span> + <span class='fills identifier id'>fills</span> <span class='lshft op'><<</span> <span class='Fill constant id'>Fill</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='pattern identifier id'>pattern</span><span class='rparen token'>)</span> + <span class='else else kw'>else</span> + <span class='integer val'>0</span> + <span class='end end kw'>end</span> + + <span class='fontId identifier id'>fontId</span> <span class='assign token'>=</span> <span class='if if kw'>if</span> <span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='dot token'>.</span><span class='values_at identifier id'>values_at</span><span class='lparen token'>(</span><span class='symbol val'>:fg_color</span><span class='comma token'>,</span> <span class='symbol val'>:sz</span><span class='comma token'>,</span> <span class='symbol val'>:b</span><span class='comma token'>,</span> <span class='symbol val'>:i</span><span class='comma token'>,</span> <span class='symbol val'>:strike</span><span class='comma token'>,</span> <span class='symbol val'>:outline</span><span class='comma token'>,</span> <span class='symbol val'>:shadow</span><span class='comma token'>,</span> <span class='symbol val'>:charset</span><span class='comma token'>,</span> <span class='symbol val'>:family</span><span class='comma token'>,</span> <span class='symbol val'>:font_name</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='length identifier id'>length</span><span class='rparen token'>)</span> + <span class='font identifier id'>font</span> <span class='assign token'>=</span> <span class='Font constant id'>Font</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='rparen token'>)</span> + <span class='lbrack token'>[</span><span class='symbol val'>:b</span><span class='comma token'>,</span> <span class='symbol val'>:i</span><span class='comma token'>,</span> <span class='symbol val'>:strike</span><span class='comma token'>,</span> <span class='symbol val'>:outline</span><span class='comma token'>,</span> <span class='symbol val'>:shadow</span><span class='comma token'>,</span> <span class='symbol val'>:charset</span><span class='comma token'>,</span> <span class='symbol val'>:family</span><span class='comma token'>,</span> <span class='symbol val'>:sz</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='k identifier id'>k</span><span class='bitor op'>|</span> <span class='font identifier id'>font</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{k}="</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='k identifier id'>k</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='k identifier id'>k</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> <span class='rbrace token'>}</span> + <span class='font identifier id'>font</span><span class='dot token'>.</span><span class='color identifier id'>color</span> <span class='assign token'>=</span> <span class='Color constant id'>Color</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:rgb</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:fg_color</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:fg_color</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='font identifier id'>font</span><span class='dot token'>.</span><span class='name identifier id'>name</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:font_name</span><span class='rbrack token'>]</span> <span class='unless unless_mod kw'>unless</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:font_name</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='fonts identifier id'>fonts</span> <span class='lshft op'><<</span> <span class='font identifier id'>font</span> + <span class='else else kw'>else</span> + <span class='integer val'>0</span> + <span class='end end kw'>end</span> + + <span class='applyProtection identifier id'>applyProtection</span> <span class='assign token'>=</span> <span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:hidden</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:locked</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='integer val'>1</span> <span class='colon op'>:</span> <span class='integer val'>0</span> + + <span class='xf identifier id'>xf</span> <span class='assign token'>=</span> <span class='Xf constant id'>Xf</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:fillId</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='fill identifier id'>fill</span><span class='comma token'>,</span> <span class='symbol val'>:fontId=</span><span class='gt op'>></span><span class='fontId identifier id'>fontId</span><span class='comma token'>,</span> <span class='symbol val'>:applyFill=</span><span class='gt op'>></span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='symbol val'>:applyFont=</span><span class='gt op'>></span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='symbol val'>:numFmtId=</span><span class='gt op'>></span><span class='numFmtId identifier id'>numFmtId</span><span class='comma token'>,</span> <span class='symbol val'>:borderId=</span><span class='gt op'>></span><span class='borderId identifier id'>borderId</span><span class='comma token'>,</span> <span class='symbol val'>:applyProtection=</span><span class='gt op'>></span><span class='applyProtection identifier id'>applyProtection</span><span class='rparen token'>)</span> + + <span class='if if kw'>if</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:alignment</span><span class='rbrack token'>]</span> + <span class='xf identifier id'>xf</span><span class='dot token'>.</span><span class='alignment identifier id'>alignment</span> <span class='assign token'>=</span> <span class='CellAlignment constant id'>CellAlignment</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:alignment</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> + + <span class='if if kw'>if</span> <span class='applyProtection identifier id'>applyProtection</span> + <span class='xf identifier id'>xf</span><span class='dot token'>.</span><span class='protection identifier id'>protection</span> <span class='assign token'>=</span> <span class='CellProtection constant id'>CellProtection</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> + + <span class='cellXfs identifier id'>cellXfs</span> <span class='lshft op'><<</span> <span class='xf identifier id'>xf</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="to_xml-instance_method"> + + - (<tt>String</tt>) <strong>to_xml</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Serializes the styles document +</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"> + + +239 +240 +241 +242 +243 +244 +245 +246 +247 +248</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 239</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='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='styleSheet identifier id'>styleSheet</span><span class='lparen token'>(</span><span class='symbol val'>:xmlns</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS constant id'>XML_NS</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='lbrack token'>[</span><span class='symbol val'>:numFmts</span><span class='comma token'>,</span> <span class='symbol val'>:fonts</span><span class='comma token'>,</span> <span class='symbol val'>:fills</span><span class='comma token'>,</span> <span class='symbol val'>:borders</span><span class='comma token'>,</span> <span class='symbol val'>:cellStyleXfs</span><span class='comma token'>,</span> <span class='symbol val'>:cellXfs</span><span class='comma token'>,</span> <span class='symbol val'>:dxfs</span><span class='comma token'>,</span> <span class='symbol val'>:tableStyles</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='key identifier id'>key</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='lbrack token'>[</span><span class='key identifier id'>key</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:44:06 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/TableStyle.html b/doc/Axlsx/TableStyle.html new file mode 100644 index 00000000..99a4846c --- /dev/null +++ b/doc/Axlsx/TableStyle.html @@ -0,0 +1,710 @@ +<!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::TableStyle + + — 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 (T)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">TableStyle</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::TableStyle + + + +</h1> + +<dl class="box"> + + <dt class="r1">Inherits:</dt> + <dd class="r1"> + <span class="inheritName"><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></span> + + <ul class="fullTree"> + <li>Object</li> + + <li class="next"><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></li> + + <li class="next">Axlsx::TableStyle</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/stylesheet/table_style.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> +Table are not supported in this version and only the defaults required for +a valid workbook are created. +</p> +</div> + </div> + +<p> +A single table style definition and is a collection for tableStyleElements +</p> + + + </div> +</div> +<div class="tags"> + + +</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="#name-instance_method" title="#name (instance method)">- (string) <strong>name</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The name of this table style. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#pivot-instance_method" title="#pivot (instance method)">- (Boolean) <strong>pivot</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +indicates if this style should be applied to pivot tables. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#table-instance_method" title="#table (instance method)">- (Boolean) <strong>table</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +indicates if this style should be applied to tables. +</p> +</div></span> + +</li> + + + </ul> + + + + + + + + + <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></h3> + <p class="inherited"><span class='object_link'><a href="SimpleTypedList.html#allowed_types-instance_method" title="Axlsx::SimpleTypedList#allowed_types (method)">allowed_types</a></span>, <span class='object_link'><a href="SimpleTypedList.html#locked_at-instance_method" title="Axlsx::SimpleTypedList#locked_at (method)">locked_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#serialize_as-instance_method" title="Axlsx::SimpleTypedList#serialize_as (method)">serialize_as</a></span></p> + + + + <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)">- (TableStyle) <strong>initialize</strong>(name, options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +creates a new TableStyle object. +</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 table style. +</p> +</div></span> + +</li> + + + </ul> + + + + + + + + + + + <h3 class="inherited">Methods inherited from <span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></h3> + <p class="inherited"><span class='object_link'><a href="SimpleTypedList.html#%3C%3C-instance_method" title="Axlsx::SimpleTypedList#<< (method)">#<<</a></span>, <span class='object_link'><a href="SimpleTypedList.html#%5B%5D%3D-instance_method" title="Axlsx::SimpleTypedList#[]= (method)">#[]=</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete-instance_method" title="Axlsx::SimpleTypedList#delete (method)">#delete</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete_at-instance_method" title="Axlsx::SimpleTypedList#delete_at (method)">#delete_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#lock-instance_method" title="Axlsx::SimpleTypedList#lock (method)">#lock</a></span>, <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">#method_missing</a></span>, <span class='object_link'><a href="SimpleTypedList.html#protected%3F-instance_method" title="Axlsx::SimpleTypedList#protected? (method)">#protected?</a></span>, <span class='object_link'><a href="SimpleTypedList.html#push-instance_method" title="Axlsx::SimpleTypedList#push (method)">#push</a></span>, <span class='object_link'><a href="SimpleTypedList.html#unlock-instance_method" title="Axlsx::SimpleTypedList#unlock (method)">#unlock</a></span></p> +<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::TableStyle (class)">TableStyle</a></span></tt>) <strong>initialize</strong>(name, options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +creates a new TableStyle object +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>name</span> + + + <span class='type'>(<tt>String</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">pivot</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">table</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + +<h3>Raises:</h3> +<ul class="raise"> + + <li> + + + <span class='type'>(<tt>ArgumentError</tt>)</span> + + + + — + <div class='inline'><p> +if name option is not provided. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +23 +24 +25 +26 +27 +28 +29</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style.rb', line 23</span> + +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='name identifier id'>name</span> <span class='assign token'>=</span> <span class='name identifier id'>name</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> + <span class='super super kw'>super</span> <span class='TableStyleElement constant id'>TableStyleElement</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> +<div id="method_missing_details" class="method_details_list"> + <h2>Dynamic Method Handling</h2> + <p class="notice super"> + This class handles dynamic methods through the <tt>method_missing</tt> method + + in the class <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">Axlsx::SimpleTypedList</a></span> + + </p> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="name=-instance_method"></span> + <span id="name-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="name-instance_method"> + + - (<tt>string</tt>) <strong>name</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The name of this table style +</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"> + + +8 +9 +10</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style.rb', line 8</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="pivot=-instance_method"></span> + <span id="pivot-instance_method"></span> + <div class="method_details "> + <p class="signature " id="pivot-instance_method"> + + - (<tt>Boolean</tt>) <strong>pivot</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +indicates if this style should be applied to pivot tables +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +12 +13 +14</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style.rb', line 12</span> + +<span class='def def kw'>def</span> <span class='pivot identifier id'>pivot</span> + <span class='@pivot ivar id'>@pivot</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="table=-instance_method"></span> + <span id="table-instance_method"></span> + <div class="method_details "> + <p class="signature " id="table-instance_method"> + + - (<tt>Boolean</tt>) <strong>table</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +indicates if this style should be applied to tables +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +16 +17 +18</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style.rb', line 16</span> + +<span class='def def kw'>def</span> <span class='table identifier id'>table</span> + <span class='@table ivar id'>@table</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 table style +</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"> + + +38 +39 +40 +41 +42</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style.rb', line 38</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='attr identifier id'>attr</span> <span class='assign token'>=</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='dot token'>.</span><span class='select identifier id'>select</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='k identifier id'>k</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='bitor op'>|</span> <span class='lbrack token'>[</span><span class='symbol val'>:name</span><span class='comma token'>,</span> <span class='symbol val'>:pivot</span><span class='comma token'>,</span> <span class='symbol val'>:table</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='include? fid id'>include?</span> <span class='k identifier id'>k</span> <span class='rbrace token'>}</span> + <span class='attr identifier id'>attr</span><span class='lbrack token'>[</span><span class='symbol val'>:count</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='size identifier id'>size</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='tableStyle identifier id'>tableStyle</span><span class='lparen token'>(</span><span class='attr identifier id'>attr</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='table_style_el identifier id'>table_style_el</span><span class='bitor op'>|</span> <span class='table_style_el identifier id'>table_style_el</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43:59 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/TableStyleElement.html b/doc/Axlsx/TableStyleElement.html new file mode 100644 index 00000000..d062d012 --- /dev/null +++ b/doc/Axlsx/TableStyleElement.html @@ -0,0 +1,677 @@ +<!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::TableStyleElement + + — 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 (T)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">TableStyleElement</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::TableStyleElement + + + +</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::TableStyleElement</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/stylesheet/table_style_element.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> +tables and table styles are not supported in this version. This class +exists in preparation for that support. +</p> +</div> + </div> + +<p> +an element of style that belongs to a table style. +</p> + + + </div> +</div> +<div class="tags"> + + +</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="#dxfId-instance_method" title="#dxfId (instance method)">- (Integer) <strong>dxfId</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The dxfId this style element points to. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#size-instance_method" title="#size (instance method)">- (Integer) <strong>size</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Number of rows or columns used in striping when the type is firstRowStripe, +secondRowStripe, firstColumnStripe, or secondColumnStripe. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#type-instance_method" title="#type (instance method)">- (Symbol) <strong>type</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The type of style element. +</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)">- (TableStyleElement) <strong>initialize</strong>(options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +creates a new TableStyleElement object. +</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 table style element. +</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::TableStyleElement (class)">TableStyleElement</a></span></tt>) <strong>initialize</strong>(options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +creates a new TableStyleElement object +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <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">type</span> + <span class="type">(<tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">size</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">dxfId</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +49 +50 +51 +52 +53</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style_element.rb', line 49</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='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="dxfId=-instance_method"></span> + <span id="dxfId-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="dxfId-instance_method"> + + - (<tt>Integer</tt>) <strong>dxfId</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The dxfId this style element points to +</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"> + + +43 +44 +45</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style_element.rb', line 43</span> + +<span class='def def kw'>def</span> <span class='dxfId identifier id'>dxfId</span> + <span class='@dxfId ivar id'>@dxfId</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="size=-instance_method"></span> + <span id="size-instance_method"></span> + <div class="method_details "> + <p class="signature " id="size-instance_method"> + + - (<tt>Integer</tt>) <strong>size</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Number of rows or columns used in striping when the type is firstRowStripe, +secondRowStripe, firstColumnStripe, or secondColumnStripe. +</p> + + + </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"> + + +39 +40 +41</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style_element.rb', line 39</span> + +<span class='def def kw'>def</span> <span class='size identifier id'>size</span> + <span class='@size ivar id'>@size</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="type=-instance_method"></span> + <span id="type-instance_method"></span> + <div class="method_details "> + <p class="signature " id="type-instance_method"> + + - (<tt>Symbol</tt>) <strong>type</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The type of style element. The following type are allowed +</p> +<pre class="code"> + <span class='symbol val'>:wholeTable</span> + <span class='symbol val'>:headerRow</span> + <span class='symbol val'>:totalRow</span> + <span class='symbol val'>:firstColumn</span> + <span class='symbol val'>:lastColumn</span> + <span class='symbol val'>:firstRowStripe</span> + <span class='symbol val'>:secondRowStripe</span> + <span class='symbol val'>:firstColumnStripe</span> + <span class='symbol val'>:secondColumnStripe</span> + <span class='symbol val'>:firstHeaderCell</span> + <span class='symbol val'>:lastHeaderCell</span> + <span class='symbol val'>:firstTotalCell</span> + <span class='symbol val'>:lastTotalCell</span> + <span class='symbol val'>:firstSubtotalColumn</span> + <span class='symbol val'>:secondSubtotalColumn</span> + <span class='symbol val'>:thirdSubtotalColumn</span> + <span class='symbol val'>:firstSubtotalRow</span> + <span class='symbol val'>:secondSubtotalRow</span> + <span class='symbol val'>:thirdSubtotalRow</span> + <span class='symbol val'>:blankRow</span> + <span class='symbol val'>:firstColumnSubheading</span> + <span class='symbol val'>:secondColumnSubheading</span> + <span class='symbol val'>:thirdColumnSubheading</span> + <span class='symbol val'>:firstRowSubheading</span> + <span class='symbol val'>:secondRowSubheading</span> + <span class='symbol val'>:thirdRowSubheading</span> + <span class='symbol val'>:pageFieldLabels</span> + <span class='symbol val'>:pageFieldValues</span> +</pre> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Symbol</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +35 +36 +37</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style_element.rb', line 35</span> + +<span class='def def kw'>def</span> <span class='type identifier id'>type</span> + <span class='@type ivar id'>@type</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 table style element +</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"> + + +62 +63 +64</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style_element.rb', line 62</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='tableStyleElement identifier id'>tableStyleElement</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:44:00 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/TableStyles.html b/doc/Axlsx/TableStyles.html new file mode 100644 index 00000000..c66b002c --- /dev/null +++ b/doc/Axlsx/TableStyles.html @@ -0,0 +1,599 @@ +<!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::TableStyles + + — 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 (T)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">TableStyles</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::TableStyles + + + +</h1> + +<dl class="box"> + + <dt class="r1">Inherits:</dt> + <dd class="r1"> + <span class="inheritName"><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></span> + + <ul class="fullTree"> + <li>Object</li> + + <li class="next"><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></li> + + <li class="next">Axlsx::TableStyles</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/stylesheet/table_styles.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> +Support for custom table styles does not exist in this version. Many of the +classes required are defined in preparation for future release. Please do +not attempt to add custom table styles. +</p> +</div> + </div> + +<p> +TableStyles represents a collection of style definitions for table styles +and pivot table styles. +</p> + + + </div> +</div> +<div class="tags"> + + +</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="#defaultPivotStyle-instance_method" title="#defaultPivotStyle (instance method)">- (String) <strong>defaultPivotStyle</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The default pivot table style. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#defaultTableStyle-instance_method" title="#defaultTableStyle (instance method)">- (String) <strong>defaultTableStyle</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The default table style. +</p> +</div></span> + +</li> + + + </ul> + + + + + + + + + <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></h3> + <p class="inherited"><span class='object_link'><a href="SimpleTypedList.html#allowed_types-instance_method" title="Axlsx::SimpleTypedList#allowed_types (method)">allowed_types</a></span>, <span class='object_link'><a href="SimpleTypedList.html#locked_at-instance_method" title="Axlsx::SimpleTypedList#locked_at (method)">locked_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#serialize_as-instance_method" title="Axlsx::SimpleTypedList#serialize_as (method)">serialize_as</a></span></p> + + + + <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)">- (TableStyles) <strong>initialize</strong>(options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new TableStyles object that is a container for TableStyle +objects. +</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 table styles element. +</p> +</div></span> + +</li> + + + </ul> + + + + + + + + + + + <h3 class="inherited">Methods inherited from <span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></h3> + <p class="inherited"><span class='object_link'><a href="SimpleTypedList.html#%3C%3C-instance_method" title="Axlsx::SimpleTypedList#<< (method)">#<<</a></span>, <span class='object_link'><a href="SimpleTypedList.html#%5B%5D%3D-instance_method" title="Axlsx::SimpleTypedList#[]= (method)">#[]=</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete-instance_method" title="Axlsx::SimpleTypedList#delete (method)">#delete</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete_at-instance_method" title="Axlsx::SimpleTypedList#delete_at (method)">#delete_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#lock-instance_method" title="Axlsx::SimpleTypedList#lock (method)">#lock</a></span>, <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">#method_missing</a></span>, <span class='object_link'><a href="SimpleTypedList.html#protected%3F-instance_method" title="Axlsx::SimpleTypedList#protected? (method)">#protected?</a></span>, <span class='object_link'><a href="SimpleTypedList.html#push-instance_method" title="Axlsx::SimpleTypedList#push (method)">#push</a></span>, <span class='object_link'><a href="SimpleTypedList.html#unlock-instance_method" title="Axlsx::SimpleTypedList#unlock (method)">#unlock</a></span></p> +<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::TableStyles (class)">TableStyles</a></span></tt>) <strong>initialize</strong>(options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new TableStyles object that is a container for TableStyle objects +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <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">defaultTableStyle</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">defaultPivotStyle</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +18 +19 +20 +21 +22</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_styles.rb', line 18</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='@defaultTableStyle ivar id'>@defaultTableStyle</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:defaultTableStyle</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='string val'>"TableStyleMedium9"</span> + <span class='@defaultPivotStyle ivar id'>@defaultPivotStyle</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:defaultPivotStyle</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='string val'>"PivotStyleLight16"</span> + <span class='super super kw'>super</span> <span class='TableStyle constant id'>TableStyle</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> +<div id="method_missing_details" class="method_details_list"> + <h2>Dynamic Method Handling</h2> + <p class="notice super"> + This class handles dynamic methods through the <tt>method_missing</tt> method + + in the class <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">Axlsx::SimpleTypedList</a></span> + + </p> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="defaultPivotStyle=-instance_method"></span> + <span id="defaultPivotStyle-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="defaultPivotStyle-instance_method"> + + - (<tt>String</tt>) <strong>defaultPivotStyle</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The default pivot table style. The default value is +‘PivotStyleLight6’ +</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/stylesheet/table_styles.rb', line 13</span> + +<span class='def def kw'>def</span> <span class='defaultPivotStyle identifier id'>defaultPivotStyle</span> + <span class='@defaultPivotStyle ivar id'>@defaultPivotStyle</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="defaultTableStyle=-instance_method"></span> + <span id="defaultTableStyle-instance_method"></span> + <div class="method_details "> + <p class="signature " id="defaultTableStyle-instance_method"> + + - (<tt>String</tt>) <strong>defaultTableStyle</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The default table style. The default value is +‘TableStyleMedium9’ +</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"> + + +9 +10 +11</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_styles.rb', line 9</span> + +<span class='def def kw'>def</span> <span class='defaultTableStyle identifier id'>defaultTableStyle</span> + <span class='@defaultTableStyle ivar id'>@defaultTableStyle</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 table styles element +</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"> + + +30 +31 +32 +33 +34 +35 +36</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_styles.rb', line 30</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='attr identifier id'>attr</span> <span class='assign token'>=</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='dot token'>.</span><span class='reject identifier id'>reject</span> <span class='lbrace token'>{</span><span class='bitor op'>|</span><span class='k identifier id'>k</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='bitor op'>|</span> <span class='notop op'>!</span><span class='lbrack token'>[</span><span class='symbol val'>:defaultTableStyle</span><span class='comma token'>,</span> <span class='symbol val'>:defaultPivotStyle</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='include? fid id'>include?</span><span class='lparen token'>(</span><span class='k identifier id'>k</span><span class='dot token'>.</span><span class='to_sym identifier id'>to_sym</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> + <span class='attr identifier id'>attr</span><span class='lbrack token'>[</span><span class='symbol val'>:count</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='size identifier id'>size</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='tableStyles identifier id'>tableStyles</span><span class='lparen token'>(</span><span class='attr identifier id'>attr</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='table_style identifier id'>table_style</span><span class='bitor op'>|</span> <span class='table_style identifier id'>table_style</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43: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> + + </body> +</html>
\ No newline at end of file diff --git a/doc/Axlsx/Title.html b/doc/Axlsx/Title.html new file mode 100644 index 00000000..678c2837 --- /dev/null +++ b/doc/Axlsx/Title.html @@ -0,0 +1,621 @@ +<!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::Title + + — 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 (T)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">Title</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::Title + + + +</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::Title</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/drawing/title.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +A Title stores information about the title of a chart +</p> + + + </div> +</div> +<div class="tags"> + + +</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="#cell-instance_method" title="#cell (instance method)">- (Cell) <strong>cell</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The cell that holds the text for the title. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#text-instance_method" title="#text (instance method)">- (String) <strong>text</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The text to be shown. +</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)">- (Title) <strong>initialize</strong>(title = "") </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new Title object. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#range-instance_method" title="#range (instance method)">- (String) <strong>range</strong> </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +returns the excel style abslute reference for the title when title is a +Cell object. +</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 chart title. +</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::Title (class)">Title</a></span></tt>) <strong>initialize</strong>(title = "") + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new Title object +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>title</span> + + + <span class='type'>(<tt>String</tt>, <tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>)</span> + + + <em class="default">(defaults to: <tt>""</tt>)</em> + + + — + <div class='inline'><p> +The cell or string to be used for the chart’s title +</p> +</div> + + </li> + +</ul> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +15 +16 +17 +18</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/title.rb', line 15</span> + +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='title identifier id'>title</span><span class='assign token'>=</span><span class='string val'>""</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='cell identifier id'>cell</span> <span class='assign token'>=</span> <span class='title identifier id'>title</span> <span class='if if_mod kw'>if</span> <span class='title identifier id'>title</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Cell constant id'>Cell</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='text identifier id'>text</span> <span class='assign token'>=</span> <span class='title identifier id'>title</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span> <span class='unless unless_mod kw'>unless</span> <span class='title identifier id'>title</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Cell constant id'>Cell</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="cell=-instance_method"></span> + <span id="cell-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="cell-instance_method"> + + - (<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>) <strong>cell</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The cell that holds the text for the title. Setting this property will +automatically update the text attribute. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +11 +12 +13</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/title.rb', line 11</span> + +<span class='def def kw'>def</span> <span class='cell identifier id'>cell</span> + <span class='@cell ivar id'>@cell</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="text=-instance_method"></span> + <span id="text-instance_method"></span> + <div class="method_details "> + <p class="signature " id="text-instance_method"> + + - (<tt>String</tt>) <strong>text</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The text to be shown. Setting this property directly with a string will +remove the cell reference. +</p> + + + </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"> + + +7 +8 +9</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/title.rb', line 7</span> + +<span class='def def kw'>def</span> <span class='text identifier id'>text</span> + <span class='@text ivar id'>@text</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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="range-instance_method"> + + - (<tt>String</tt>) <strong>range</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +returns the excel style abslute reference for the title when title is a +Cell object +</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"> + + +63 +64 +65 +66</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/title.rb', line 63</span> + +<span class='def def kw'>def</span> <span class='range identifier id'>range</span> + <span class='return return kw'>return</span> <span class='string val'>""</span> <span class='unless unless_mod kw'>unless</span> <span class='@data ivar id'>@data</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Cell constant id'>Cell</span><span class='rparen token'>)</span> + <span class='dstring node'>"#{@data.row.worksheet.name}!#{data.row.r_abs}"</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 chart title +</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"> + + +43 +44 +45 +46 +47 +48 +49 +50 +51 +52 +53 +54 +55 +56 +57</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/title.rb', line 43</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:title'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:tx'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:strRef'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:f'</span><span class='comma token'>,</span> <span class='range identifier id'>range</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:strCache'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:ptCount'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='integer val'>1</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:pt'</span><span class='comma token'>,</span> <span class='symbol val'>:idx=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:v'</span><span class='comma token'>,</span> <span class='@text ivar id'>@text</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:44:04 2011 by + <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> + 0.7.3 (ruby-1.8.7). +</div> + + </body> +</html>
\ No newline at end of file diff --git a/doc/Axlsx/TwoCellAnchor.html b/doc/Axlsx/TwoCellAnchor.html new file mode 100644 index 00000000..a55c9ded --- /dev/null +++ b/doc/Axlsx/TwoCellAnchor.html @@ -0,0 +1,1115 @@ +<!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::TwoCellAnchor + + — 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 (T)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">TwoCellAnchor</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::TwoCellAnchor + + + +</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::TwoCellAnchor</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/drawing/two_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 and charts is Worksheet#add_chart. +Anchors are specified by the :start_at and :end_at options to that method. +</p> +</div> + </div> + +<p> +This class details the anchor points for drawings. +</p> + + + </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> + + </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="#graphic_frame-instance_method" title="#graphic_frame (instance method)">- (GraphicFrame) <strong>graphic_frame</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The frame for your chart. +</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="#to-instance_method" title="#to (instance method)">- (Marker) <strong>to</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +A marker that returns the to cell anchor. +</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="#end_at-instance_method" title="#end_at (instance method)">- (Marker) <strong>end_at</strong>(x, y) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +This is a short cut method to set the end anchor position. +</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, chart_type, options) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new TwoCellAnchor 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. +</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 two cell 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::TwoCellAnchor (class)">TwoCellAnchor</a></span></tt>) <strong>initialize</strong>(drawing, chart_type, options) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new TwoCellAnchor object +</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'>chart</span> + + + <span class='type'>(<tt><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></tt>)</span> + + + + </li> + + <li> + + <span class='name'>options</span> + + + <span class='type'>(<tt>Hash</tt>)</span> + + + + — + <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> + + </li> + + <li> + <span class="name">end_at</span> + <span class="type">(<tt>Array</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +31 +32 +33 +34 +35 +36 +37 +38 +39 +40 +41 +42 +43 +44</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 31</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='@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='self self kw'>self</span><span class='dot token'>.</span><span class='start_at identifier id'>start_at</span><span class='lparen token'>(</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='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span><span class='comma token'>,</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='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='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:start_at</span><span class='rbrack token'>]</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='self self kw'>self</span><span class='dot token'>.</span><span class='end_at identifier id'>end_at</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:end_at</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:end_at</span><span class='rbrack token'>]</span><span class='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='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:end_at</span><span class='rbrack token'>]</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='comment val'># passing a reference to our start and end markers for convenience</span> + <span class='comment val'># this lets us access the markers directly from the chart.</span> + <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='dot token'>.</span><span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='symbol val'>:start_at=</span><span class='comma token'>,</span> <span class='@from ivar id'>@from</span><span class='rparen token'>)</span> + <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='dot token'>.</span><span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='symbol val'>:end_at=</span><span class='comma token'>,</span> <span class='@to ivar id'>@to</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"> + + +20 +21 +22</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 20</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"> + + +9 +10 +11</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 9</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=""></span> + <span id="graphic_frame-instance_method"></span> + <div class="method_details "> + <p class="signature " id="graphic_frame-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> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The frame for your chart +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="GraphicFrame.html" title="Axlsx::GraphicFrame (class)">GraphicFrame</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +16 +17 +18</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 16</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='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"> + + +24 +25 +26</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 24</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="to-instance_method"></span> + <div class="method_details "> + <p class="signature " id="to-instance_method"> + + - (<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>) <strong>to</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +A marker that returns the to cell anchor. The default to column and row are +5 and 10 respectively +</p> + + + </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"> + + +12 +13 +14</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 12</span> + +<span class='def def kw'>def</span> <span class='to identifier id'>to</span> + <span class='@to ivar id'>@to</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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="end_at-instance_method"> + + - (<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>) <strong>end_at</strong>(x, y) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +This is a short cut method to set the end anchor position +</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"> + + +65 +66 +67 +68 +69</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 65</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='@to ivar id'>@to</span><span class='dot token'>.</span><span class='col identifier id'>col</span> <span class='assign token'>=</span> <span class='x identifier id'>x</span> + <span class='@to ivar id'>@to</span><span class='dot token'>.</span><span class='row identifier id'>row</span> <span class='assign token'>=</span> <span class='y identifier id'>y</span> + <span class='@to ivar id'>@to</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " 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 +</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"> + + +55 +56 +57 +58 +59</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 55</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='@from ivar 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='@from ivar 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='@from ivar id'>@from</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 two cell 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"> + + +74 +75 +76 +77 +78 +79 +80 +81 +82 +83 +84 +85 +86</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 74</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> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:twoCellAnchor'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:from'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='from identifier id'>from</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:to'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='to identifier id'>to</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='@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='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 Sun Nov 20 23:43:56 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/ValAxis.html b/doc/Axlsx/ValAxis.html new file mode 100644 index 00000000..13a9ea9a --- /dev/null +++ b/doc/Axlsx/ValAxis.html @@ -0,0 +1,539 @@ +<!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::ValAxis + + — 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 (V)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">ValAxis</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::ValAxis + + + +</h1> + +<dl class="box"> + + <dt class="r1">Inherits:</dt> + <dd class="r1"> + <span class="inheritName"><span class='object_link'><a href="Axis.html" title="Axlsx::Axis (class)">Axis</a></span></span> + + <ul class="fullTree"> + <li>Object</li> + + <li class="next"><span class='object_link'><a href="Axis.html" title="Axlsx::Axis (class)">Axis</a></span></li> + + <li class="next">Axlsx::ValAxis</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/drawing/val_axis.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +the ValAxis class defines a chart value axis. +</p> + + + </div> +</div> +<div class="tags"> + + +</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="#crossBetween-instance_method" title="#crossBetween (instance method)">- (Symbol) <strong>crossBetween</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +This element specifies whether the value axis crosses the category axis +between categories. +</p> +</div></span> + +</li> + + + </ul> + + + + + + + + + <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Axis.html" title="Axlsx::Axis (class)">Axis</a></span></h3> + <p class="inherited"><span class='object_link'><a href="Axis.html#axId-instance_method" title="Axlsx::Axis#axId (method)">axId</a></span>, <span class='object_link'><a href="Axis.html#axPos-instance_method" title="Axlsx::Axis#axPos (method)">axPos</a></span>, <span class='object_link'><a href="Axis.html#crossAx-instance_method" title="Axlsx::Axis#crossAx (method)">crossAx</a></span>, <span class='object_link'><a href="Axis.html#crosses-instance_method" title="Axlsx::Axis#crosses (method)">crosses</a></span>, <span class='object_link'><a href="Axis.html#format_code-instance_method" title="Axlsx::Axis#format_code (method)">format_code</a></span>, <span class='object_link'><a href="Axis.html#scaling-instance_method" title="Axlsx::Axis#scaling (method)">scaling</a></span>, <span class='object_link'><a href="Axis.html#tickLblPos-instance_method" title="Axlsx::Axis#tickLblPos (method)">tickLblPos</a></span></p> + + + + <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)">- (ValAxis) <strong>initialize</strong>(axId, crossAx, options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new ValAxis object. +</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 value axis. +</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::ValAxis (class)">ValAxis</a></span></tt>) <strong>initialize</strong>(axId, crossAx, options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new ValAxis object +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>axId</span> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +the id of this axis +</p> +</div> + + </li> + + <li> + + <span class='name'>crossAx</span> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +the id of the perpendicular axis +</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">axPos</span> + <span class="type">(<tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">crosses</span> + <span class="type">(<tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">tickLblPos</span> + <span class="type">(<tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">crossesBetween</span> + <span class="type">(<tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +17 +18 +19 +20</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/val_axis.rb', line 17</span> + +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='axId identifier id'>axId</span><span class='comma token'>,</span> <span class='crossAx identifier id'>crossAx</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@crossBetween ivar id'>@crossBetween</span> <span class='assign token'>=</span> <span class='symbol val'>:between</span> + <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='axId identifier id'>axId</span><span class='comma token'>,</span> <span class='crossAx identifier id'>crossAx</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="crossBetween=-instance_method"></span> + <span id="crossBetween-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="crossBetween-instance_method"> + + - (<tt>Symbol</tt>) <strong>crossBetween</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +This element specifies whether the value axis crosses the category axis +between categories. must be one of [:between, :midCat] +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Symbol</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +8 +9 +10</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/val_axis.rb', line 8</span> + +<span class='def def kw'>def</span> <span class='crossBetween identifier id'>crossBetween</span> + <span class='@crossBetween ivar id'>@crossBetween</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 value axis +</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"> + + +27 +28 +29 +30 +31 +32</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/val_axis.rb', line 27</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:valAx'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:crossBetween'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@crossBetween ivar id'>@crossBetween</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43: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> + + </body> +</html>
\ No newline at end of file diff --git a/doc/Axlsx/View3D.html b/doc/Axlsx/View3D.html new file mode 100644 index 00000000..e42b3bbc --- /dev/null +++ b/doc/Axlsx/View3D.html @@ -0,0 +1,971 @@ +<!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::View3D + + — 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 (V)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">View3D</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::View3D + + + +</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::View3D</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/drawing/view_3D.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +3D attributes for a chart. +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + <h2>Constant Summary</h2> + + <dl class="constants"> + + <dt id="H_PERCENT_REGEX-constant" class="">H_PERCENT_REGEX = + <div class="docstring"> + <div class="discussion"> + <p> +Validation for hPercent +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='regexp val'>/0*(([5-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)%/</span> +</pre></dd> + + <dt id="DEPTH_PERCENT_REGEX-constant" class="">DEPTH_PERCENT_REGEX = + <div class="docstring"> + <div class="discussion"> + <p> +validation for depthPercent +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='regexp val'>/0*(([2-9][0-9])|([1-9][0-9][0-9])|(1[0-9][0-9][0-9])|2000)%/</span> +</pre></dd> + + </dl> + + + + <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="#depthPercent-instance_method" title="#depthPercent (instance method)">- (String) <strong>depthPercent</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +depth or chart as % of chart width must be between 20% and 2000%. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#hPercent-instance_method" title="#hPercent (instance method)">- (String) <strong>hPercent</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +height of chart as % of chart must be between 5% and 500%. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#perspective-instance_method" title="#perspective (instance method)">- (Integer) <strong>perspective</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +field of view angle. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#rAngAx-instance_method" title="#rAngAx (instance method)">- (Boolean) <strong>rAngAx</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Chart axis are at right angles. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#rotX-instance_method" title="#rotX (instance method)">- (Integer) <strong>rotX</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +x rotation for the chart must be between -90 and 90. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#rotY-instance_method" title="#rotY (instance method)">- (Integer) <strong>rotY</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +y rotation for the chart must be between 0 and 360. +</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)">- (View3D) <strong>initialize</strong>(options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new View3D for charts. +</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 view3D properties. +</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::View3D (class)">View3D</a></span></tt>) <strong>initialize</strong>(options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new View3D for charts +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <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">rotX</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">hPercent</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">rotY</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">depthPercent</span> + <span class="type">(<tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">rAngAx</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">perspective</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +39 +40 +41 +42 +43</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 39</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='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="depthPercent=-instance_method"></span> + <span id="depthPercent-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="depthPercent-instance_method"> + + - (<tt>String</tt>) <strong>depthPercent</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +depth or chart as % of chart width must be between 20% and 2000% +</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"> + + +22 +23 +24</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 22</span> + +<span class='def def kw'>def</span> <span class='depthPercent identifier id'>depthPercent</span> + <span class='@depthPercent ivar id'>@depthPercent</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="hPercent=-instance_method"></span> + <span id="hPercent-instance_method"></span> + <div class="method_details "> + <p class="signature " id="hPercent-instance_method"> + + - (<tt>String</tt>) <strong>hPercent</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +height of chart as % of chart must be between 5% and 500% +</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"> + + +12 +13 +14</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 12</span> + +<span class='def def kw'>def</span> <span class='hPercent identifier id'>hPercent</span> + <span class='@hPercent ivar id'>@hPercent</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="perspective=-instance_method"></span> + <span id="perspective-instance_method"></span> + <div class="method_details "> + <p class="signature " id="perspective-instance_method"> + + - (<tt>Integer</tt>) <strong>perspective</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +field of view angle +</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"> + + +30 +31 +32</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 30</span> + +<span class='def def kw'>def</span> <span class='perspective identifier id'>perspective</span> + <span class='@perspective ivar id'>@perspective</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="rAngAx=-instance_method"></span> + <span id="rAngAx-instance_method"></span> + <div class="method_details "> + <p class="signature " id="rAngAx-instance_method"> + + - (<tt>Boolean</tt>) <strong>rAngAx</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Chart axis are at right angles +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +26 +27 +28</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 26</span> + +<span class='def def kw'>def</span> <span class='rAngAx identifier id'>rAngAx</span> + <span class='@rAngAx ivar id'>@rAngAx</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="rotX=-instance_method"></span> + <span id="rotX-instance_method"></span> + <div class="method_details "> + <p class="signature " id="rotX-instance_method"> + + - (<tt>Integer</tt>) <strong>rotX</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +x rotation for the chart must be between -90 and 90 +</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"> + + +7 +8 +9</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 7</span> + +<span class='def def kw'>def</span> <span class='rotX identifier id'>rotX</span> + <span class='@rotX ivar id'>@rotX</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="rotY=-instance_method"></span> + <span id="rotY-instance_method"></span> + <div class="method_details "> + <p class="signature " id="rotY-instance_method"> + + - (<tt>Integer</tt>) <strong>rotY</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +y rotation for the chart must be between 0 and 360 +</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"> + + +17 +18 +19</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 17</span> + +<span class='def def kw'>def</span> <span class='rotY identifier id'>rotY</span> + <span class='@rotY ivar id'>@rotY</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 view3D properties +</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"> + + +61 +62 +63 +64 +65 +66 +67 +68 +69 +70</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 61</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:view3D'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:rotX'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@rotX ivar id'>@rotX</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@rotX ivar id'>@rotX</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:hPercent'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@hPercent ivar id'>@hPercent</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@hPercent ivar id'>@hPercent</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:rotY'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@rotY ivar id'>@rotY</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@rotY ivar id'>@rotY</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:depthPercent'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@depthPercent ivar id'>@depthPercent</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@depthPercent ivar id'>@depthPercent</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:rAngAx'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@rAngAx ivar id'>@rAngAx</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@rAngAx ivar id'>@rAngAx</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:perspective'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@perspective ivar id'>@perspective</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@perspective ivar id'>@perspective</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:44:04 2011 by + <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> + 0.7.3 (ruby-1.8.7). +</div> + + </body> +</html>
\ No newline at end of file diff --git a/doc/Axlsx/Workbook.html b/doc/Axlsx/Workbook.html new file mode 100644 index 00000000..2e7b8aa6 --- /dev/null +++ b/doc/Axlsx/Workbook.html @@ -0,0 +1,1347 @@ +<!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::Workbook + + — 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 (W)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">Workbook</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::Workbook + + + +</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::Workbook</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/workbook/workbook.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +The Workbook class is an xlsx workbook that manages worksheets, charts, +drawings and styles. The following parts of the Office Open XML spreadsheet +specification are not implimented in this version. +</p> +<pre class="code"> + <span class='bookViews identifier id'>bookViews</span> + <span class='calcPr identifier id'>calcPr</span> + <span class='customWorkbookViews identifier id'>customWorkbookViews</span> + <span class='definedNames identifier id'>definedNames</span> + <span class='externalReferences identifier id'>externalReferences</span> + <span class='extLst identifier id'>extLst</span> + <span class='fileRecoveryPr identifier id'>fileRecoveryPr</span> + <span class='fileSharing identifier id'>fileSharing</span> + <span class='fileVersion identifier id'>fileVersion</span> + <span class='functionGroups identifier id'>functionGroups</span> + <span class='oleSize identifier id'>oleSize</span> + <span class='pivotCaches identifier id'>pivotCaches</span> + <span class='smartTagPr identifier id'>smartTagPr</span> + <span class='smartTagTypes identifier id'>smartTagTypes</span> + <span class='webPublishing identifier id'>webPublishing</span> + <span class='webPublishObjects identifier id'>webPublishObjects</span> + <span class='workbookProtection identifier id'>workbookProtection</span> + <span class='workbookPr identifier id'>workbookPr</span><span class='mult op'>*</span> + + <span class='mult op'>*</span><span class='workbookPr identifier id'>workbookPr</span> <span class='is identifier id'>is</span> <span class='only identifier id'>only</span> <span class='supported identifier id'>supported</span> <span class='to identifier id'>to</span> <span class='the identifier id'>the</span> <span class='extend identifier id'>extend</span> <span class='of identifier id'>of</span> <span class='date1904 identifier id'>date1904</span> +</pre> + + + </div> +</div> +<div class="tags"> + + +</div> + <h2>Constant Summary</h2> + + <dl class="constants"> + + <dt id="date1904-classvariable" class="">@@date1904 = + <div class="docstring"> + <div class="discussion"> + <p> +Indicates if the epoc date for serialization should be 1904. If false, 1900 +is used. +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='false false kw'>false</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="#charts-instance_method" title="#charts (instance method)">- (SimpleTypedList) <strong>charts</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +A colllection of charts associated with this workbook. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#date1904-instance_method" title="#date1904 (instance method)">- (Boolean) <strong>date1904</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Instance level access to the class variable 1904. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#drawings-instance_method" title="#drawings (instance method)">- (SimpleTypedList) <strong>drawings</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +A colllection of drawings 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> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The workbook relationships. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#styles-instance_method" title="#styles (instance method)">- (Styles) <strong>styles</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The styles associated with this workbook. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#worksheets-instance_method" title="#worksheets (instance method)">- (SimpleTypedList) <strong>worksheets</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +A collection of worksheets associated with this workbook. +</p> +</div></span> + +</li> + + + </ul> + + + + + + <h2> + Class Method Summary + <small>(<a href="#" class="summary_toggle">collapse</a>)</small> + </h2> + + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> + + <a href="#date1904-class_method" title="date1904 (class method)">+ (Boolean) <strong>date1904</strong> </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +retrieves the date1904 attribute. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#date1904%3D-class_method" title="date1904= (class method)">+ (Boolean) <strong>date1904=</strong>(v) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Sets the date1904 attribute to the provided boolean. +</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="#add_worksheet-instance_method" title="#add_worksheet (instance method)">- (Worksheet) <strong>add_worksheet</strong>(options = {}) {|worksheet| ... }</a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Adds a worksheet to this workbook. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#initialize-instance_method" title="#initialize (instance method)">- (Workbook) <strong>initialize</strong>(options = {}) {|_self| ... }</a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new Workbook. +</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> </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Serializes the workbook document. +</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::Workbook (class)">Workbook</a></span></tt>) <strong>initialize</strong>(options = {}) {|_self| ... } + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new Workbook +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <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">date1904</span> + <span class="type">(<tt>Boolean</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::Workbook (class)">Axlsx::Workbook</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"> + + +75 +76 +77 +78 +79 +80 +81 +82</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 75</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='self self kw'>self</span><span class='dot token'>.</span><span class='date1904 identifier id'>date1904</span><span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:date1904</span><span class='rbrack token'>]</span> <span class='unless unless_mod kw'>unless</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:date1904</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='yield yield kw'>yield</span> <span class='self self kw'>self</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id=""></span> + <span id="charts-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="charts-instance_method"> + + - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>charts</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 charts is Worksheet#add_chart +</p> +</div> + </div> + +<p> +A colllection of charts 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_chart-instance_method" title="Axlsx::Worksheet#add_chart (method)">Axlsx::Worksheet#add_chart</a></span></li> + + <li><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +45 +46 +47</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 45</span> + +<span class='def def kw'>def</span> <span class='charts identifier id'>charts</span> + <span class='@charts ivar id'>@charts</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="date1904=-instance_method"></span> + <span id="date1904-instance_method"></span> + <div class="method_details "> + <p class="signature " id="date1904-instance_method"> + + - (<tt>Boolean</tt>) <strong>date1904</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Instance level access to the class variable 1904 +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +67</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 67</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> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="drawings-instance_method"></span> + <div class="method_details "> + <p class="signature " id="drawings-instance_method"> + + - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>drawings</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 drawings is Worksheet#add_chart +</p> +</div> + </div> + +<p> +A colllection of drawings 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_chart-instance_method" title="Axlsx::Worksheet#add_chart (method)">Axlsx::Worksheet#add_chart</a></span></li> + + <li><span class='object_link'><a href="Drawing.html" title="Axlsx::Drawing (class)">Drawing</a></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/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='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="relationships-instance_method"></span> + <div class="method_details "> + <p class="signature " id="relationships-instance_method"> + + - (<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>) <strong>relationships</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The workbook relationships. This is managed automatically by the workbook +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +63 +64 +65 +66 +67 +68 +69 +70</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 63</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='@worksheets ivar id'>@worksheets</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span> + <span class='r identifier id'>r</span> <span class='lshft op'><<</span> <span class='Relationship constant id'>Relationship</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='WORKSHEET_R constant id'>WORKSHEET_R</span><span class='comma token'>,</span> <span class='WORKSHEET_PN constant id'>WORKSHEET_PN</span> <span class='mod op'>%</span> <span class='lparen token'>(</span><span class='r identifier id'>r</span><span class='dot token'>.</span><span class='size identifier id'>size</span><span class='plus op'>+</span><span class='integer val'>1</span><span class='rparen token'>)</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> + <span class='r identifier id'>r</span> <span class='lshft op'><<</span> <span class='Relationship constant id'>Relationship</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='STYLES_R constant id'>STYLES_R</span><span class='comma token'>,</span> <span class='STYLES_PN constant id'>STYLES_PN</span><span class='rparen token'>)</span> + <span class='r identifier id'>r</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="styles-instance_method"></span> + <div class="method_details "> + <p class="signature " id="styles-instance_method"> + + - (<tt><span class='object_link'><a href="Styles.html" title="Axlsx::Styles (class)">Styles</a></span></tt>) <strong>styles</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 styles is Styles#add_style +</p> +</div> + </div> + +<p> +The styles 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="Styles.html" title="Axlsx::Styles (class)">Styles</a></span></tt>)</span> + + + + </li> + +</ul> + + <h3>See Also:</h3> + <ul class="see"> + + <li>Style#add_style</li> + + <li>Style</li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <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='styles identifier id'>styles</span> + <span class='@styles ivar id'>@styles</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="worksheets-instance_method"></span> + <div class="method_details "> + <p class="signature " id="worksheets-instance_method"> + + - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>worksheets</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 worksheets is add_worksheet +</p> +</div> + </div> + +<p> +A collection of worksheets 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="#add_worksheet-instance_method" title="Axlsx::Workbook#add_worksheet (method)">#add_worksheet</a></span></li> + + <li><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Axlsx::Worksheet</a></span></li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +38 +39 +40</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 38</span> + +<span class='def def kw'>def</span> <span class='worksheets identifier id'>worksheets</span> + <span class='@worksheets ivar id'>@worksheets</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + + + <div id="class_method_details" class="method_details_list"> + <h2>Class Method Details</h2> + + + <div class="method_details first"> + <p class="signature first" id="date1904-class_method"> + + + (<tt>Boolean</tt>) <strong>date1904</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +retrieves the date1904 attribute +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +93</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 93</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> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="date1904=-class_method"> + + + (<tt>Boolean</tt>) <strong>date1904=</strong>(v) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Sets the date1904 attribute to the provided boolean +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +89</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 89</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> + </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="add_worksheet-instance_method"> + + - (<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>) <strong>add_worksheet</strong>(options = {}) {|worksheet| ... } + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Adds a worksheet to this workbook +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <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> + — <div class='inline'><p> +The name of the worksheet. +</p> +</div> + </li> + + </ul> + + +<h3>Yields:</h3> +<ul class="yield"> + + <li> + + + <span class='type'>(<tt>worksheet</tt>)</span> + + + + </li> + +</ul> +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>)</span> + + + + </li> + +</ul> + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="Worksheet.html#initialize-instance_method" title="Axlsx::Worksheet#initialize (method)">Axlsx::Worksheet#initialize</a></span></li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +99 +100 +101 +102 +103</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 99</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> + <span class='yield yield kw'>yield</span> <span class='worksheet identifier id'>worksheet</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> + <span class='worksheet identifier id'>worksheet</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="to_xml-instance_method"> + + - (<tt>String</tt>) <strong>to_xml</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Serializes the workbook document +</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"> + + +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/workbook/workbook.rb', line 116</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> + <span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='lparen token'>(</span><span class='symbol val'>:xmlns</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS constant id'>XML_NS</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:r'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS_R constant id'>XML_NS_R</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='workbookPr identifier id'>workbookPr</span><span class='lparen token'>(</span><span class='symbol val'>:date1904=</span><span class='gt op'>></span><span class='@@date1904 ivar id'>@@date1904</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='sheets identifier id'>sheets</span> <span class='lbrace token'>{</span> + <span class='@worksheets ivar id'>@worksheets</span><span class='dot token'>.</span><span class='each_with_index identifier id'>each_with_index</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='sheet identifier id'>sheet</span><span class='lparen token'>(</span><span class='symbol val'>:name=</span><span class='gt op'>></span><span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='symbol val'>:sheetId=</span><span class='gt op'>></span><span class='index identifier id'>index</span><span class='plus op'>+</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='symbol val'>:"r:id"</span><span class='assign token'>=</span><span class='gt op'>></span><span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rId identifier id'>rId</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='symbol val'>:indent=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43:53 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/Worksheet.html b/doc/Axlsx/Worksheet.html new file mode 100644 index 00000000..36a5798c --- /dev/null +++ b/doc/Axlsx/Worksheet.html @@ -0,0 +1,1864 @@ +<!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::Worksheet + + — 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 (W)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">Worksheet</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::Worksheet + + + +</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::Worksheet</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/workbook/worksheet/worksheet.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +The Worksheet class represents a worksheet in the workbook. +</p> + + + </div> +</div> +<div class="tags"> + + +</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="#auto_fit_data-instance_method" title="#auto_fit_data (instance method)">- (Array) <strong>auto_fit_data</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +An array of content based calculated column widths. +</p> +</div></span> + +</li> + + + <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 associated with this worksheet. +</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 worksheet in the owning Workbook’s worksheets list. +</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 of the worksheet. +</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 of this worksheet. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#relationships-instance_method" title="#relationships (instance method)">- (Object) <strong>relationships</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The worksheet’s relationships. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#rels_pn-instance_method" title="#rels_pn (instance method)">- (String) <strong>rels_pn</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The relationship part name of this worksheet. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#rId-instance_method" title="#rId (instance method)">- (String) <strong>rId</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The relationship Id of thiw worksheet. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#rows-instance_method" title="#rows (instance method)">- (SimpleTypedList) <strong>rows</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The rows in this worksheet. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#workbook-instance_method" title="#workbook (instance method)">- (Workbook) <strong>workbook</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The workbook that owns this worksheet. +</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="#add_chart-instance_method" title="#add_chart (instance method)">- (Object) <strong>add_chart</strong>(chart_type, options = {}) {|chart| ... }</a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Adds a chart to this 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> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Adds a row to the worksheet and updates auto fit data. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#auto_width-instance_method" title="#auto_width (instance method)">- (Float) <strong>auto_width</strong>(col) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Determines the proper width for a column based on content. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#initialize-instance_method" title="#initialize (instance method)">- (Worksheet) <strong>initialize</strong>(wb, options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new worksheet. +</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> </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Serializes the worksheet document. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#update_auto_fit_data-instance_method" title="#update_auto_fit_data (instance method)">- (Array) <strong>update_auto_fit_data</strong>(cells) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Updates auto fit data. +</p> +</div></span> + +</li> + + + </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::Worksheet (class)">Worksheet</a></span></tt>) <strong>initialize</strong>(wb, options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +the recommended way to manage worksheets is Workbook#add_worksheet +</p> +</div> + </div> + +<p> +Creates a new worksheet. +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <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> + — <div class='inline'><p> +The name of this sheet. +</p> +</div> + </li> + + </ul> + + + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="Workbook.html#add_worksheet-instance_method" title="Axlsx::Workbook#add_worksheet (method)">Axlsx::Workbook#add_worksheet</a></span></li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +59 +60 +61 +62 +63 +64 +65 +66</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 59</span> + +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='wb identifier id'>wb</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@rows ivar id'>@rows</span> <span class='assign token'>=</span> <span class='SimpleTypedList constant id'>SimpleTypedList</span><span class='dot token'>.</span><span class='new identifier id'>new</span> <span class='Row constant id'>Row</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span> <span class='assign token'>=</span> <span class='wb identifier id'>wb</span> + <span class='@workbook ivar id'>@workbook</span><span class='dot token'>.</span><span class='worksheets identifier id'>worksheets</span> <span class='lshft op'><<</span> <span class='self self kw'>self</span> + <span class='@auto_fit_data ivar id'>@auto_fit_data</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='name identifier id'>name</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:name</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='string val'>"Sheet"</span> <span class='plus op'>+</span> <span class='lparen token'>(</span><span class='index identifier id'>index</span><span class='plus op'>+</span><span class='integer val'>1</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span> + <span class='@magick_draw ivar id'>@magick_draw</span> <span class='assign token'>=</span> <span class='Magick constant id'>Magick</span><span class='colon2 op'>::</span><span class='Draw constant id'>Draw</span><span class='dot token'>.</span><span class='new identifier id'>new</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id=""></span> + <span id="auto_fit_data-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="auto_fit_data-instance_method"> + + - (<tt>Array</tt>) <strong>auto_fit_data</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +a single auto fit data item is a hash with :longest => [String] and +:sz=> [Integer] members. +</p> +</div> + </div> + +<p> +An array of content based calculated column widths. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Array</tt>)</span> + + + + — + <div class='inline'><p> +of Hash +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +34 +35 +36</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 34</span> + +<span class='def def kw'>def</span> <span class='auto_fit_data identifier id'>auto_fit_data</span> + <span class='@auto_fit_data ivar id'>@auto_fit_data</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="drawing-instance_method"></span> + <div class="method_details "> + <p class="signature " 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"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +the recommended way to work with drawings and charts is Worksheet#add_chart +</p> +</div> + </div> + +<p> +The drawing associated with this worksheet. +</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> + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="#add_chart-instance_method" title="Axlsx::Worksheet#add_chart (method)">#add_chart</a></span></li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +29 +30 +31</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 29</span> + +<span class='def def kw'>def</span> <span class='drawing identifier id'>drawing</span> + <span class='@drawing ivar id'>@drawing</span> <span class='orop op'>||</span> <span class='@drawing ivar id'>@drawing</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Drawing constant id'>Drawing</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 worksheet in the owning Workbook’s worksheets list. +</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"> + + +50 +51 +52</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 50</span> + +<span class='def def kw'>def</span> <span class='index identifier id'>index</span> + <span class='@workbook ivar id'>@workbook</span><span class='dot token'>.</span><span class='worksheets identifier id'>worksheets</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 of the worksheet +</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"> + + +9 +10 +11</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 9</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 of this worksheet +</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"> + + +38 +39 +40</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 38</span> + +<span class='def def kw'>def</span> <span class='pn identifier id'>pn</span> + <span class='dstring node'>"#{WORKSHEET_PN % (index+1)}"</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="relationships-instance_method"></span> + <div class="method_details "> + <p class="signature " id="relationships-instance_method"> + + - (<tt>Object</tt>) <strong>relationships</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The worksheet’s relationships. +</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +17 +18 +19 +20 +21</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 17</span> + +<span class='def def kw'>def</span> <span class='relationships identifier id'>relationships</span> + <span class='r identifier id'>r</span> <span class='assign token'>=</span> <span class='Relationships constant id'>Relationships</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='r identifier id'>r</span> <span class='lshft op'><<</span> <span class='Relationship constant id'>Relationship</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='DRAWING_R constant id'>DRAWING_R</span><span class='comma token'>,</span> <span class='dstring node'>"../#{@drawing.pn}"</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='@drawing ivar id'>@drawing</span> + <span class='r identifier id'>r</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="rels_pn-instance_method"></span> + <div class="method_details "> + <p class="signature " id="rels_pn-instance_method"> + + - (<tt>String</tt>) <strong>rels_pn</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The relationship part name of this worksheet +</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"> + + +42 +43 +44</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 42</span> + +<span class='def def kw'>def</span> <span class='rels_pn identifier id'>rels_pn</span> + <span class='dstring node'>"#{WORKSHEET_RELS_PN % (index+1)}"</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="rId-instance_method"></span> + <div class="method_details "> + <p class="signature " id="rId-instance_method"> + + - (<tt>String</tt>) <strong>rId</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The relationship Id of thiw worksheet +</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"> + + +46 +47 +48</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 46</span> + +<span class='def def kw'>def</span> <span class='rId identifier id'>rId</span> + <span class='dstring node'>"rId#{index+1}"</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="rows-instance_method"></span> + <div class="method_details "> + <p class="signature " id="rows-instance_method"> + + - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>rows</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 rows is Worksheet#add_row +</p> +</div> + </div> + +<p> +The rows in this worksheet +</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="#add_row-instance_method" title="Axlsx::Worksheet#add_row (method)">#add_row</a></span></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/workbook/worksheet/worksheet.rb', line 23</span> + +<span class='def def kw'>def</span> <span class='rows identifier id'>rows</span> + <span class='@rows ivar id'>@rows</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="workbook=-instance_method"></span> + <span id="workbook-instance_method"></span> + <div class="method_details "> + <p class="signature " id="workbook-instance_method"> + + - (<tt><span class='object_link'><a href="Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span></tt>) <strong>workbook</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The workbook that owns this worksheet +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span></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/workbook/worksheet/worksheet.rb', line 13</span> + +<span class='def def kw'>def</span> <span class='workbook identifier id'>workbook</span> + <span class='@workbook ivar id'>@workbook</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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="add_chart-instance_method"> + + - (<tt>Object</tt>) <strong>add_chart</strong>(chart_type, options = {}) {|chart| ... } + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Adds a chart to this worksheets drawing. +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>chart_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">start_at</span> + <span class="type">(<tt>Array</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">end_at</span> + <span class="type">(<tt>Array</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">title</span> + <span class="type">(<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>, <tt>String</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + +<h3>Yields:</h3> +<ul class="yield"> + + <li> + + + <span class='type'>(<tt>chart</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +108 +109 +110 +111 +112</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 108</span> + +<span class='def def kw'>def</span> <span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='chart_type identifier id'>chart_type</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='chart identifier id'>chart</span> <span class='assign token'>=</span> <span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='chart_type identifier id'>chart_type</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='yield yield kw'>yield</span> <span class='chart identifier id'>chart</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> + <span class='chart identifier id'>chart</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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| ... } + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Adds a row to the worksheet and updates auto fit data +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <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">values</span> + <span class="type">(<tt>Array</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">types</span> + <span class="type">(<tt>Array</tt>, <tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">style</span> + <span class="type">(<tt>Array</tt>, <tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + +<h3>Yields:</h3> +<ul class="yield"> + + <li> + + + <span class='type'>(<tt>@rows.last</tt>)</span> + + + + </li> + +</ul> +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Row.html" title="Axlsx::Row (class)">Row</a></span></tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +96 +97 +98 +99 +100 +101</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 96</span> + +<span class='def def kw'>def</span> <span class='add_row identifier id'>add_row</span><span class='lparen token'>(</span><span class='values identifier id'>values</span><span class='assign token'>=</span><span class='lbrack token'>[</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='Row constant id'>Row</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='comma token'>,</span> <span class='values identifier id'>values</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='update_auto_fit_data identifier id'>update_auto_fit_data</span> <span class='@rows ivar id'>@rows</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span> + <span class='yield yield kw'>yield</span> <span class='@rows ivar id'>@rows</span><span class='dot token'>.</span><span class='last identifier id'>last</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> + <span class='@rows ivar id'>@rows</span><span class='dot token'>.</span><span class='last identifier id'>last</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="auto_width-instance_method"> + + - (<tt>Float</tt>) <strong>auto_width</strong>(col) + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +From ECMA docs +</p> +<pre class="code"> + <span class='Column constant id'>Column</span> <span class='width identifier id'>width</span> <span class='measured identifier id'>measured</span> <span class='as identifier id'>as</span> <span class='the identifier id'>the</span> <span class='number identifier id'>number</span> <span class='of identifier id'>of</span> <span class='characters identifier id'>characters</span> <span class='of identifier id'>of</span> <span class='the identifier id'>the</span> <span class='maximum identifier id'>maximum</span> <span class='digit identifier id'>digit</span> <span class='width identifier id'>width</span> <span class='of identifier id'>of</span> <span class='the identifier id'>the</span> <span class='numbers identifier id'>numbers</span> <span class='integer val'>0</span> <span class='dot2 op'>..</span> <span class='integer val'>9</span> <span class='as identifier id'>as</span> + <span class='rendered identifier id'>rendered</span> <span class='in in kw'>in</span> <span class='the identifier id'>the</span> <span class='normal identifier id'>normal</span> <span class='style identifier id'>style</span><span class='string val'>'s font. There are 4 pixels of margin padding (two on each side), plus 1 pixel padding for the gridlines. + width = Truncate([{Number of Characters} * {Maximum Digit Width} + {5 pixel padding}]/{Maximum Digit Width}*256)/256 +</span></pre> +</div> + </div> + +<p> +Determines the proper width for a column based on content. +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>A</span> + + + <span class='type'>(<tt>Hash</tt>)</span> + + + + — + <div class='inline'><p> +hash of auto_fit_data +</p> +</div> + + </li> + +</ul> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Float</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +182 +183 +184 +185 +186 +187 +188 +189 +190 +191</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 182</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_count identifier id'>mdw_count</span> <span class='assign token'>=</span> <span class='integer val'>0</span> + <span class='best_guess identifier id'>best_guess</span> <span class='assign token'>=</span> <span class='float val'>1.5</span> <span class='comment val'>#direct testing shows the results of the documented formula to be a bit too small. This is a best guess scaling</span> + <span class='font_scale identifier id'>font_scale</span> <span class='assign token'>=</span> <span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:sz</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='to_f identifier id'>to_f</span> <span class='div op'>/</span> <span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='fonts identifier id'>fonts</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='sz identifier id'>sz</span><span class='dot token'>.</span><span class='to_f identifier id'>to_f</span> <span class='orop op'>||</span> <span class='float val'>11.0</span><span class='rparen token'>)</span> + <span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:longest</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='scan identifier id'>scan</span><span class='lparen token'>(</span><span class='regexp val'>/./</span><span class='mu identifier id'>mu</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='i identifier id'>i</span><span class='bitor op'>|</span> + <span class='mdw_count identifier id'>mdw_count</span> <span class='opasgn op'>+=</span><span class='integer val'>1</span> <span class='if if_mod kw'>if</span> <span class='@magick_draw ivar id'>@magick_draw</span><span class='dot token'>.</span><span class='get_type_metrics identifier id'>get_type_metrics</span><span class='lparen token'>(</span><span class='i identifier id'>i</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='width identifier id'>width</span> <span class='geq op'>>=</span> <span class='mdw identifier id'>mdw</span> + <span class='end end kw'>end</span> + <span class='lparen token'>(</span><span class='lparen token'>(</span><span class='mdw_count identifier id'>mdw_count</span> <span class='mult op'>*</span> <span class='mdw identifier id'>mdw</span> <span class='plus op'>+</span> <span class='integer val'>5</span><span class='rparen token'>)</span> <span class='div op'>/</span> <span class='mdw identifier id'>mdw</span> <span class='mult op'>*</span> <span class='integer val'>256</span><span class='rparen token'>)</span> <span class='div op'>/</span> <span class='float val'>256.0</span> <span class='mult op'>*</span> <span class='best_guess identifier id'>best_guess</span> <span class='mult op'>*</span> <span class='font_scale identifier id'>font_scale</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="to_xml-instance_method"> + + - (<tt>String</tt>) <strong>to_xml</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Serializes the worksheet document +</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"> + + +116 +117 +118 +119 +120 +121 +122 +123 +124 +125 +126 +127 +128 +129 +130 +131 +132 +133 +134 +135 +136</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 116</span> + +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span> + <span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='worksheet identifier id'>worksheet</span><span class='lparen token'>(</span><span class='symbol val'>:xmlns</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS constant id'>XML_NS</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:r'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS_R constant id'>XML_NS_R</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='if if kw'>if</span> <span class='@auto_fit_data ivar id'>@auto_fit_data</span><span class='dot token'>.</span><span class='size identifier id'>size</span> <span class='gt op'>></span> <span class='integer val'>0</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='cols identifier id'>cols</span> <span class='lbrace token'>{</span> + <span class='@auto_fit_data ivar id'>@auto_fit_data</span><span class='dot token'>.</span><span class='each_with_index identifier id'>each_with_index</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='col identifier id'>col</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span> + <span class='min_max identifier id'>min_max</span> <span class='assign token'>=</span> <span class='index identifier id'>index</span><span class='plus op'>+</span><span class='integer val'>1</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='col identifier id'>col</span><span class='lparen token'>(</span><span class='symbol val'>:min=</span><span class='gt op'>></span><span class='min_max identifier id'>min_max</span><span class='comma token'>,</span> <span class='symbol val'>:max=</span><span class='gt op'>></span><span class='min_max identifier id'>min_max</span><span class='comma token'>,</span> <span class='symbol val'>:width</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='auto_width identifier id'>auto_width</span><span class='lparen token'>(</span><span class='col identifier id'>col</span><span class='rparen token'>)</span><span class='comma token'>,</span> <span class='symbol val'>:customWidth=</span><span class='gt op'>></span><span class='string val'>"true"</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='sheetData identifier id'>sheetData</span> <span class='lbrace token'>{</span> + <span class='@rows ivar id'>@rows</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='row identifier id'>row</span><span class='bitor op'>|</span> + <span class='row identifier id'>row</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> + <span class='rbrace token'>}</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='drawing identifier id'>drawing</span> <span class='symbol val'>:"r:id"</span><span class='assign token'>=</span><span class='gt op'>></span><span class='string val'>"rId1"</span> <span class='if if_mod kw'>if</span> <span class='@drawing ivar id'>@drawing</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='symbol val'>:indent=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='comma token'>,</span> <span class='symbol val'>:save_with=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <p class="signature " id="update_auto_fit_data-instance_method"> + + - (<tt>Array</tt>) <strong>update_auto_fit_data</strong>(cells) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Updates auto fit data. Autofit data attempts to determine the cell in a +column that has the greatest width by comparing the length of the text +multiplied by the size of the font. +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>cells</span> + + + <span class='type'>(<tt>Array</tt>)</span> + + + + — + <div class='inline'><p> +an array of cells +</p> +</div> + + </li> + +</ul> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Array</tt>)</span> + + + + — + <div class='inline'><p> +of Cell objects +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +154 +155 +156 +157 +158 +159 +160 +161 +162 +163 +164 +165 +166 +167 +168 +169 +170 +171 +172</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 154</span> + +<span class='def def kw'>def</span> <span class='update_auto_fit_data identifier id'>update_auto_fit_data</span><span class='lparen token'>(</span><span class='cells identifier id'>cells</span><span class='rparen token'>)</span> + <span class='styles identifier id'>styles</span> <span class='assign token'>=</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span> + <span class='cellXfs identifier id'>cellXfs</span><span class='comma token'>,</span> <span class='fonts identifier id'>fonts</span> <span class='assign token'>=</span> <span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='cellXfs identifier id'>cellXfs</span><span class='comma token'>,</span> <span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='fonts identifier id'>fonts</span> + <span class='sz identifier id'>sz</span> <span class='assign token'>=</span> <span class='fonts identifier id'>fonts</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='sz identifier id'>sz</span> + + <span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='each_with_index identifier id'>each_with_index</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='item identifier id'>item</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span> + <span class='col identifier id'>col</span> <span class='assign token'>=</span> <span class='@auto_fit_data ivar id'>@auto_fit_data</span><span class='lbrack token'>[</span><span class='index identifier id'>index</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='lbrace token'>{</span><span class='symbol val'>:longest=</span><span class='gt op'>></span><span class='string val'>""</span><span class='comma token'>,</span> <span class='symbol val'>:sz=</span><span class='gt op'>></span><span class='sz identifier id'>sz</span><span class='rbrace token'>}</span> + <span class='cell_xf identifier id'>cell_xf</span> <span class='assign token'>=</span> <span class='cellXfs identifier id'>cellXfs</span><span class='lbrack token'>[</span><span class='item identifier id'>item</span><span class='dot token'>.</span><span class='style identifier id'>style</span><span class='rbrack token'>]</span> + <span class='font identifier id'>font</span> <span class='assign token'>=</span> <span class='fonts identifier id'>fonts</span><span class='lbrack token'>[</span><span class='cell_xf identifier id'>cell_xf</span><span class='dot token'>.</span><span class='fontId identifier id'>fontId</span> <span class='orop op'>||</span> <span class='integer val'>0</span><span class='rbrack token'>]</span> + <span class='sz identifier id'>sz</span> <span class='assign token'>=</span> <span class='font identifier id'>font</span><span class='dot token'>.</span><span class='sz identifier id'>sz</span> <span class='orop op'>||</span> <span class='sz identifier id'>sz</span> + + <span class='if if kw'>if</span> <span class='lparen token'>(</span><span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:longest</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='scan identifier id'>scan</span><span class='lparen token'>(</span><span class='regexp val'>/./</span><span class='mu identifier id'>mu</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='size identifier id'>size</span> <span class='mult op'>*</span> <span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:sz</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='lt op'><</span> <span class='lparen token'>(</span><span class='item identifier id'>item</span><span class='dot token'>.</span><span class='value identifier id'>value</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='dot token'>.</span><span class='scan identifier id'>scan</span><span class='lparen token'>(</span><span class='regexp val'>/./</span><span class='mu identifier id'>mu</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='size identifier id'>size</span> <span class='mult op'>*</span> <span class='sz identifier id'>sz</span><span class='rparen token'>)</span> + <span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:sz</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='sz identifier id'>sz</span> + <span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:longest</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='item identifier id'>item</span><span class='dot token'>.</span><span class='value identifier id'>value</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span> + <span class='end end kw'>end</span> + <span class='@auto_fit_data ivar id'>@auto_fit_data</span><span class='lbrack token'>[</span><span class='index identifier id'>index</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='col identifier id'>col</span> + <span class='end end kw'>end</span> + <span class='cells identifier id'>cells</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43:53 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/Xf.html b/doc/Axlsx/Xf.html new file mode 100644 index 00000000..45320bb1 --- /dev/null +++ b/doc/Axlsx/Xf.html @@ -0,0 +1,1681 @@ +<!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::Xf + + — 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 (X)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">Xf</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::Xf + + + +</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::Xf</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/stylesheet/xf.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +The Xf class defines a formatting record for use in Styles +</p> + + + </div> +</div> +<div class="tags"> + + +</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="#alignment-instance_method" title="#alignment (instance method)">- (CellAlignment) <strong>alignment</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The cell alignment for this style. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#applyAlignment-instance_method" title="#applyAlignment (instance method)">- (Boolean) <strong>applyAlignment</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Indicates if the alignment options should be applied. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#applyBorder-instance_method" title="#applyBorder (instance method)">- (Boolean) <strong>applyBorder</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +indicates if the borderId should be applied. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#applyFill-instance_method" title="#applyFill (instance method)">- (Boolean) <strong>applyFill</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +indicates if the fillId should be applied. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#applyFont-instance_method" title="#applyFont (instance method)">- (Boolean) <strong>applyFont</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +indicates if the fontId should be applied. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#applyNumberFormat-instance_method" title="#applyNumberFormat (instance method)">- (Boolean) <strong>applyNumberFormat</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +indicates if the numFmtId should be applied. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#applyProtection-instance_method" title="#applyProtection (instance method)">- (Boolean) <strong>applyProtection</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Indicates if the protection options should be applied. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#borderId-instance_method" title="#borderId (instance method)">- (Integer) <strong>borderId</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +index (0 based) of the border to be used in this style. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#fillId-instance_method" title="#fillId (instance method)">- (Integer) <strong>fillId</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +index (0 based) of the fill to be used in this style. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#fontId-instance_method" title="#fontId (instance method)">- (Integer) <strong>fontId</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +index (0 based) of the font to be used in this style. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#numFmtId-instance_method" title="#numFmtId (instance method)">- (Integer) <strong>numFmtId</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +id of the numFmt to apply to this style. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#pivotButton-instance_method" title="#pivotButton (instance method)">- (Boolean) <strong>pivotButton</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +indicates if the cell has a pivot table drop down button. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#protection-instance_method" title="#protection (instance method)">- (CellProtection) <strong>protection</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The cell protection for this style. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#quotePrefix-instance_method" title="#quotePrefix (instance method)">- (Boolean) <strong>quotePrefix</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +indecates if text should be prefixed by a single quote in the cell. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#xfId-instance_method" title="#xfId (instance method)">- (Integer) <strong>xfId</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +index (0 based) of cellStylesXfs item to be used in this style. +</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)">- (Xf) <strong>initialize</strong>(options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new Xf object. +</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 xf elemen. +</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::Xf (class)">Xf</a></span></tt>) <strong>initialize</strong>(options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new Xf object +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>[Integer]</span> + + + <span class='type'>(<tt>Hash</tt>)</span> + + + + — + <div class='inline'><p> +a customizable set of options +</p> +</div> + + </li> + + <li> + + <span class='name'>[Boolean]</span> + + + <span class='type'>(<tt>Hash</tt>)</span> + + + + — + <div class='inline'><p> +a customizable set of options +</p> +</div> + + </li> + + <li> + + <span class='name'>[CellAlignment]</span> + + + <span class='type'>(<tt>Hash</tt>)</span> + + + + — + <div class='inline'><p> +a customizable set of options +</p> +</div> + + </li> + + <li> + + <span class='name'>[CellProtection]</span> + + + <span class='type'>(<tt>Hash</tt>)</span> + + + + — + <div class='inline'><p> +a customizable set of options +</p> +</div> + + </li> + +</ul> + + + + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +84 +85 +86 +87 +88</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 84</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='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="alignment=-instance_method"></span> + <span id="alignment-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="alignment-instance_method"> + + - (<tt><span class='object_link'><a href="CellAlignment.html" title="Axlsx::CellAlignment (class)">CellAlignment</a></span></tt>) <strong>alignment</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The cell alignment for this style +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="CellAlignment.html" title="Axlsx::CellAlignment (class)">CellAlignment</a></span></tt>)</span> + + + + </li> + +</ul> + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="CellAlignment.html" title="Axlsx::CellAlignment (class)">CellAlignment</a></span></li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +9 +10 +11</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 9</span> + +<span class='def def kw'>def</span> <span class='alignment identifier id'>alignment</span> + <span class='@alignment ivar id'>@alignment</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="applyAlignment=-instance_method"></span> + <span id="applyAlignment-instance_method"></span> + <div class="method_details "> + <p class="signature " id="applyAlignment-instance_method"> + + - (<tt>Boolean</tt>) <strong>applyAlignment</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Indicates if the alignment options should be applied +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +62 +63 +64</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 62</span> + +<span class='def def kw'>def</span> <span class='applyAlignment identifier id'>applyAlignment</span> + <span class='@applyAlignment ivar id'>@applyAlignment</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="applyBorder=-instance_method"></span> + <span id="applyBorder-instance_method"></span> + <div class="method_details "> + <p class="signature " id="applyBorder-instance_method"> + + - (<tt>Boolean</tt>) <strong>applyBorder</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +indicates if the borderId should be applied +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +58 +59 +60</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 58</span> + +<span class='def def kw'>def</span> <span class='applyBorder identifier id'>applyBorder</span> + <span class='@applyBorder ivar id'>@applyBorder</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="applyFill=-instance_method"></span> + <span id="applyFill-instance_method"></span> + <div class="method_details "> + <p class="signature " id="applyFill-instance_method"> + + - (<tt>Boolean</tt>) <strong>applyFill</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +indicates if the fillId should be applied +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +54 +55 +56</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 54</span> + +<span class='def def kw'>def</span> <span class='applyFill identifier id'>applyFill</span> + <span class='@applyFill ivar id'>@applyFill</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="applyFont=-instance_method"></span> + <span id="applyFont-instance_method"></span> + <div class="method_details "> + <p class="signature " id="applyFont-instance_method"> + + - (<tt>Boolean</tt>) <strong>applyFont</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +indicates if the fontId should be applied +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +50 +51 +52</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 50</span> + +<span class='def def kw'>def</span> <span class='applyFont identifier id'>applyFont</span> + <span class='@applyFont ivar id'>@applyFont</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="applyNumberFormat=-instance_method"></span> + <span id="applyNumberFormat-instance_method"></span> + <div class="method_details "> + <p class="signature " id="applyNumberFormat-instance_method"> + + - (<tt>Boolean</tt>) <strong>applyNumberFormat</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +indicates if the numFmtId should be applied +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +46 +47 +48</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 46</span> + +<span class='def def kw'>def</span> <span class='applyNumberFormat identifier id'>applyNumberFormat</span> + <span class='@applyNumberFormat ivar id'>@applyNumberFormat</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="applyProtection=-instance_method"></span> + <span id="applyProtection-instance_method"></span> + <div class="method_details "> + <p class="signature " id="applyProtection-instance_method"> + + - (<tt>Boolean</tt>) <strong>applyProtection</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Indicates if the protection options should be applied +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +66 +67 +68</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 66</span> + +<span class='def def kw'>def</span> <span class='applyProtection identifier id'>applyProtection</span> + <span class='@applyProtection ivar id'>@applyProtection</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="borderId=-instance_method"></span> + <span id="borderId-instance_method"></span> + <div class="method_details "> + <p class="signature " id="borderId-instance_method"> + + - (<tt>Integer</tt>) <strong>borderId</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +index (0 based) of the border to be used in this style +</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"> + + +30 +31 +32</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 30</span> + +<span class='def def kw'>def</span> <span class='borderId identifier id'>borderId</span> + <span class='@borderId ivar id'>@borderId</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="fillId=-instance_method"></span> + <span id="fillId-instance_method"></span> + <div class="method_details "> + <p class="signature " id="fillId-instance_method"> + + - (<tt>Integer</tt>) <strong>fillId</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +index (0 based) of the fill to be used in this style +</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"> + + +26 +27 +28</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 26</span> + +<span class='def def kw'>def</span> <span class='fillId identifier id'>fillId</span> + <span class='@fillId ivar id'>@fillId</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="fontId=-instance_method"></span> + <span id="fontId-instance_method"></span> + <div class="method_details "> + <p class="signature " id="fontId-instance_method"> + + - (<tt>Integer</tt>) <strong>fontId</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +index (0 based) of the font to be used in this style +</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/stylesheet/xf.rb', line 22</span> + +<span class='def def kw'>def</span> <span class='fontId identifier id'>fontId</span> + <span class='@fontId ivar id'>@fontId</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="numFmtId=-instance_method"></span> + <span id="numFmtId-instance_method"></span> + <div class="method_details "> + <p class="signature " id="numFmtId-instance_method"> + + - (<tt>Integer</tt>) <strong>numFmtId</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +id of the numFmt to apply to this style +</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"> + + +18 +19 +20</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 18</span> + +<span class='def def kw'>def</span> <span class='numFmtId identifier id'>numFmtId</span> + <span class='@numFmtId ivar id'>@numFmtId</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="pivotButton=-instance_method"></span> + <span id="pivotButton-instance_method"></span> + <div class="method_details "> + <p class="signature " id="pivotButton-instance_method"> + + - (<tt>Boolean</tt>) <strong>pivotButton</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +indicates if the cell has a pivot table drop down button +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +42 +43 +44</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 42</span> + +<span class='def def kw'>def</span> <span class='pivotButton identifier id'>pivotButton</span> + <span class='@pivotButton ivar id'>@pivotButton</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="protection=-instance_method"></span> + <span id="protection-instance_method"></span> + <div class="method_details "> + <p class="signature " id="protection-instance_method"> + + - (<tt><span class='object_link'><a href="CellProtection.html" title="Axlsx::CellProtection (class)">CellProtection</a></span></tt>) <strong>protection</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The cell protection for this style +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="CellProtection.html" title="Axlsx::CellProtection (class)">CellProtection</a></span></tt>)</span> + + + + </li> + +</ul> + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="CellProtection.html" title="Axlsx::CellProtection (class)">CellProtection</a></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/stylesheet/xf.rb', line 14</span> + +<span class='def def kw'>def</span> <span class='protection identifier id'>protection</span> + <span class='@protection ivar id'>@protection</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="quotePrefix=-instance_method"></span> + <span id="quotePrefix-instance_method"></span> + <div class="method_details "> + <p class="signature " id="quotePrefix-instance_method"> + + - (<tt>Boolean</tt>) <strong>quotePrefix</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +indecates if text should be prefixed by a single quote in the cell +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +38 +39 +40</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 38</span> + +<span class='def def kw'>def</span> <span class='quotePrefix identifier id'>quotePrefix</span> + <span class='@quotePrefix ivar id'>@quotePrefix</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="xfId=-instance_method"></span> + <span id="xfId-instance_method"></span> + <div class="method_details "> + <p class="signature " id="xfId-instance_method"> + + - (<tt>Integer</tt>) <strong>xfId</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +index (0 based) of cellStylesXfs item to be used in this style. Only +applies to cellXfs items +</p> + + + </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"> + + +34 +35 +36</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 34</span> + +<span class='def def kw'>def</span> <span class='xfId identifier id'>xfId</span> + <span class='@xfId ivar id'>@xfId</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</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 xf elemen +</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"> + + +110 +111 +112 +113 +114 +115</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 110</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='xf identifier id'>xf</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='dot token'>.</span><span class='reject identifier id'>reject</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='k identifier id'>k</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='bitor op'>|</span> <span class='lbrack token'>[</span><span class='symbol val'>:alignment</span><span class='comma token'>,</span> <span class='symbol val'>:protection</span><span class='comma token'>,</span> <span class='symbol val'>:extList</span><span class='comma token'>,</span> <span class='symbol val'>:name</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='include? fid id'>include?</span> <span class='k identifier id'>k</span><span class='dot token'>.</span><span class='to_sym identifier id'>to_sym</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='alignment identifier id'>alignment</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='alignment identifier id'>alignment</span> + <span class='protection identifier id'>protection</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='protection identifier id'>protection</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:44:05 2011 by + <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> + 0.7.3 (ruby-1.8.7). +</div> + + </body> +</html>
\ No newline at end of file diff --git a/doc/_index.html b/doc/_index.html new file mode 100644 index 00000000..9baa7929 --- /dev/null +++ b/doc/_index.html @@ -0,0 +1,575 @@ +<!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> + 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"> + + + <span class="title"></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="noborder title">Documentation by YARD 0.7.3</h1> +<div id="listing"> + <h1 class="alphaindex">Alphabetic Index</h1> + + <h2>File Listing</h2> + <ul id="files"> + + + <li class="r1"><a href="index.html" title="README">README</a></li> + + + </ul> + +<div class="clear"></div> +<h2>Namespace Listing A-Z</h2> + + + + +<table> + <tr> + <td valign='top' width="33%"> + + + <ul id="alpha_A" class="alpha"> + <li class="letter">A</li> + <ul> + + <li> + <span class='object_link'><a href="Axlsx/App.html" title="Axlsx::App (class)">App</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/Axis.html" title="Axlsx::Axis (class)">Axis</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx.html" title="Axlsx (module)">Axlsx</a></span> + + </li> + + </ul> + </ul> + + + <ul id="alpha_B" class="alpha"> + <li class="letter">B</li> + <ul> + + <li> + <span class='object_link'><a href="Axlsx/Bar3DChart.html" title="Axlsx::Bar3DChart (class)">Bar3DChart</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/BarSeries.html" title="Axlsx::BarSeries (class)">BarSeries</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/Border.html" title="Axlsx::Border (class)">Border</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/BorderPr.html" title="Axlsx::BorderPr (class)">BorderPr</a></span> + + <small>(Axlsx)</small> + + </li> + + </ul> + </ul> + + + <ul id="alpha_C" class="alpha"> + <li class="letter">C</li> + <ul> + + <li> + <span class='object_link'><a href="Axlsx/CatAxis.html" title="Axlsx::CatAxis (class)">CatAxis</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/Cell.html" title="Axlsx::Cell (class)">Cell</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/CellAlignment.html" title="Axlsx::CellAlignment (class)">CellAlignment</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/CellProtection.html" title="Axlsx::CellProtection (class)">CellProtection</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/CellStyle.html" title="Axlsx::CellStyle (class)">CellStyle</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/Chart.html" title="Axlsx::Chart (class)">Chart</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/Color.html" title="Axlsx::Color (class)">Color</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/ContentType.html" title="Axlsx::ContentType (class)">ContentType</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/Core.html" title="Axlsx::Core (class)">Core</a></span> + + <small>(Axlsx)</small> + + </li> + + </ul> + </ul> + + + <ul id="alpha_D" class="alpha"> + <li class="letter">D</li> + <ul> + + <li> + <span class='object_link'><a href="Axlsx/DataTypeValidator.html" title="Axlsx::DataTypeValidator (class)">DataTypeValidator</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/Default.html" title="Axlsx::Default (class)">Default</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/Drawing.html" title="Axlsx::Drawing (class)">Drawing</a></span> + + <small>(Axlsx)</small> + + </li> + + </ul> + </ul> + + + <ul id="alpha_F" class="alpha"> + <li class="letter">F</li> + <ul> + + <li> + <span class='object_link'><a href="Axlsx/Fill.html" title="Axlsx::Fill (class)">Fill</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/Font.html" title="Axlsx::Font (class)">Font</a></span> + + <small>(Axlsx)</small> + + </li> + + </ul> + </ul> + + + <ul id="alpha_G" class="alpha"> + <li class="letter">G</li> + <ul> + + <li> + <span class='object_link'><a href="Axlsx/GradientFill.html" title="Axlsx::GradientFill (class)">GradientFill</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/GradientStop.html" title="Axlsx::GradientStop (class)">GradientStop</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/GraphicFrame.html" title="Axlsx::GraphicFrame (class)">GraphicFrame</a></span> + + <small>(Axlsx)</small> + + </li> + + </ul> + </ul> + + + <ul id="alpha_M" class="alpha"> + <li class="letter">M</li> + <ul> + + <li> + <span class='object_link'><a href="Axlsx/Marker.html" title="Axlsx::Marker (class)">Marker</a></span> + + <small>(Axlsx)</small> + + </li> + + </ul> + </ul> + + + </td><td valign='top' width="33%"> + + + <ul id="alpha_N" class="alpha"> + <li class="letter">N</li> + <ul> + + <li> + <span class='object_link'><a href="Axlsx/NumFmt.html" title="Axlsx::NumFmt (class)">NumFmt</a></span> + + <small>(Axlsx)</small> + + </li> + + </ul> + </ul> + + + <ul id="alpha_O" class="alpha"> + <li class="letter">O</li> + <ul> + + <li> + <span class='object_link'><a href="Axlsx/Override.html" title="Axlsx::Override (class)">Override</a></span> + + <small>(Axlsx)</small> + + </li> + + </ul> + </ul> + + + <ul id="alpha_P" class="alpha"> + <li class="letter">P</li> + <ul> + + <li> + <span class='object_link'><a href="Axlsx/Package.html" title="Axlsx::Package (class)">Package</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/PatternFill.html" title="Axlsx::PatternFill (class)">PatternFill</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> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/PieSeries.html" title="Axlsx::PieSeries (class)">PieSeries</a></span> + + <small>(Axlsx)</small> + + </li> + + </ul> + </ul> + + + <ul id="alpha_R" class="alpha"> + <li class="letter">R</li> + <ul> + + <li> + <span class='object_link'><a href="Axlsx/RegexValidator.html" title="Axlsx::RegexValidator (class)">RegexValidator</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/Relationship.html" title="Axlsx::Relationship (class)">Relationship</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/RestrictionValidator.html" title="Axlsx::RestrictionValidator (class)">RestrictionValidator</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/Row.html" title="Axlsx::Row (class)">Row</a></span> + + <small>(Axlsx)</small> + + </li> + + </ul> + </ul> + + + <ul id="alpha_S" class="alpha"> + <li class="letter">S</li> + <ul> + + <li> + <span class='object_link'><a href="Axlsx/Scaling.html" title="Axlsx::Scaling (class)">Scaling</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/Series.html" title="Axlsx::Series (class)">Series</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/Styles.html" title="Axlsx::Styles (class)">Styles</a></span> + + <small>(Axlsx)</small> + + </li> + + </ul> + </ul> + + + <ul id="alpha_T" class="alpha"> + <li class="letter">T</li> + <ul> + + <li> + <span class='object_link'><a href="Axlsx/TableStyle.html" title="Axlsx::TableStyle (class)">TableStyle</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/TableStyleElement.html" title="Axlsx::TableStyleElement (class)">TableStyleElement</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/TableStyles.html" title="Axlsx::TableStyles (class)">TableStyles</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/Title.html" title="Axlsx::Title (class)">Title</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/TwoCellAnchor.html" title="Axlsx::TwoCellAnchor (class)">TwoCellAnchor</a></span> + + <small>(Axlsx)</small> + + </li> + + </ul> + </ul> + + + <ul id="alpha_V" class="alpha"> + <li class="letter">V</li> + <ul> + + <li> + <span class='object_link'><a href="Axlsx/ValAxis.html" title="Axlsx::ValAxis (class)">ValAxis</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/View3D.html" title="Axlsx::View3D (class)">View3D</a></span> + + <small>(Axlsx)</small> + + </li> + + </ul> + </ul> + + + <ul id="alpha_W" class="alpha"> + <li class="letter">W</li> + <ul> + + <li> + <span class='object_link'><a href="Axlsx/Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span> + + <small>(Axlsx)</small> + + </li> + + <li> + <span class='object_link'><a href="Axlsx/Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span> + + <small>(Axlsx)</small> + + </li> + + </ul> + </ul> + + + </td><td valign='top' width="33%"> + + + <ul id="alpha_X" class="alpha"> + <li class="letter">X</li> + <ul> + + <li> + <span class='object_link'><a href="Axlsx/Xf.html" title="Axlsx::Xf (class)">Xf</a></span> + + <small>(Axlsx)</small> + + </li> + + </ul> + </ul> + + </td> + </tr> +</table> + +</div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43: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> + + </body> +</html>
\ No newline at end of file diff --git a/doc/class_list.html b/doc/class_list.html new file mode 100644 index 00000000..088ee65e --- /dev/null +++ b/doc/class_list.html @@ -0,0 +1,47 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <link rel="stylesheet" href="css/full_list.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" src="js/jquery.js"></script> + + <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script> + + + <base id="base_target" target="_parent" /> + </head> + <body> + <script type="text/javascript" charset="utf-8"> + if (window.top.frames.main) { + document.getElementById('base_target').target = 'main'; + document.body.className = 'frames'; + } + </script> + <div id="content"> + <h1 id="full_list_header">Class List</h1> + <div id="nav"> + + <a target="_self" href="class_list.html">Classes</a> + + <a target="_self" href="method_list.html">Methods</a> + + <a target="_self" href="file_list.html">Files</a> + + </div> + <div id="search">Search: <input type="text" /></div> + + <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/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/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/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/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/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> + </body> +</html> diff --git a/doc/css/common.css b/doc/css/common.css new file mode 100644 index 00000000..cf25c452 --- /dev/null +++ b/doc/css/common.css @@ -0,0 +1 @@ +/* Override this file with custom rules */
\ No newline at end of file diff --git a/doc/css/full_list.css b/doc/css/full_list.css new file mode 100644 index 00000000..3c032964 --- /dev/null +++ b/doc/css/full_list.css @@ -0,0 +1,55 @@ +body { + margin: 0; + font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; + font-size: 13px; + height: 101%; + overflow-x: hidden; +} + +h1 { padding: 12px 10px; padding-bottom: 0; margin: 0; font-size: 1.4em; } +.clear { clear: both; } +#search { position: absolute; right: 5px; top: 9px; padding-left: 24px; } +#content.insearch #search, #content.insearch #noresults { background: url(data:image/gif;base64,R0lGODlhEAAQAPYAAP///wAAAPr6+pKSkoiIiO7u7sjIyNjY2J6engAAAI6OjsbGxjIyMlJSUuzs7KamppSUlPLy8oKCghwcHLKysqSkpJqamvT09Pj4+KioqM7OzkRERAwMDGBgYN7e3ujo6Ly8vCoqKjY2NkZGRtTU1MTExDw8PE5OTj4+PkhISNDQ0MrKylpaWrS0tOrq6nBwcKysrLi4uLq6ul5eXlxcXGJiYoaGhuDg4H5+fvz8/KKiohgYGCwsLFZWVgQEBFBQUMzMzDg4OFhYWBoaGvDw8NbW1pycnOLi4ubm5kBAQKqqqiQkJCAgIK6urnJyckpKSjQ0NGpqatLS0sDAwCYmJnx8fEJCQlRUVAoKCggICLCwsOTk5ExMTPb29ra2tmZmZmhoaNzc3KCgoBISEiIiIgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH/C05FVFNDQVBFMi4wAwEAAAAh/hpDcmVhdGVkIHdpdGggYWpheGxvYWQuaW5mbwAh+QQJCAAAACwAAAAAEAAQAAAHaIAAgoMgIiYlg4kACxIaACEJCSiKggYMCRselwkpghGJBJEcFgsjJyoAGBmfggcNEx0flBiKDhQFlIoCCA+5lAORFb4AJIihCRbDxQAFChAXw9HSqb60iREZ1omqrIPdJCTe0SWI09GBACH5BAkIAAAALAAAAAAQABAAAAdrgACCgwc0NTeDiYozCQkvOTo9GTmDKy8aFy+NOBA7CTswgywJDTIuEjYFIY0JNYMtKTEFiRU8Pjwygy4ws4owPyCKwsMAJSTEgiQlgsbIAMrO0dKDGMTViREZ14kYGRGK38nHguHEJcvTyIEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDAggPg4iJAAMJCRUAJRIqiRGCBI0WQEEJJkWDERkYAAUKEBc4Po1GiKKJHkJDNEeKig4URLS0ICImJZAkuQAhjSi/wQyNKcGDCyMnk8u5rYrTgqDVghgZlYjcACTA1sslvtHRgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCQARAtOUoQRGRiFD0kJUYWZhUhKT1OLhR8wBaaFBzQ1NwAlkIszCQkvsbOHL7Y4q4IuEjaqq0ZQD5+GEEsJTDCMmIUhtgk1lo6QFUwJVDKLiYJNUd6/hoEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4uen4ICCA+IkIsDCQkVACWmhwSpFqAABQoQF6ALTkWFnYMrVlhWvIKTlSAiJiVVPqlGhJkhqShHV1lCW4cMqSkAR1ofiwsjJyqGgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCSMhREZGIYYGY2ElYebi56fhyWQniSKAKKfpaCLFlAPhl0gXYNGEwkhGYREUywag1wJwSkHNDU3D0kJYIMZQwk8MjPBLx9eXwuETVEyAC/BOKsuEjYFhoEAIfkECQgAAAAsAAAAABAAEAAAB2eAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4ueICImip6CIQkJKJ4kigynKaqKCyMnKqSEK05StgAGQRxPYZaENqccFgIID4KXmQBhXFkzDgOnFYLNgltaSAAEpxa7BQoQF4aBACH5BAkIAAAALAAAAAAQABAAAAdogACCg4SFggJiPUqCJSWGgkZjCUwZACQkgxGEXAmdT4UYGZqCGWQ+IjKGGIUwPzGPhAc0NTewhDOdL7Ykji+dOLuOLhI2BbaFETICx4MlQitdqoUsCQ2vhKGjglNfU0SWmILaj43M5oEAOwAAAAAAAAAAAA==) no-repeat center left; } +#full_list { padding: 0; list-style: none; margin-left: 0; } +#full_list ul { padding: 0; } +#full_list li { padding: 5px; padding-left: 12px; margin: 0; font-size: 1.1em; list-style: none; } +#noresults { padding: 7px 12px; } +#content.insearch #noresults { margin-left: 7px; } +ul.collapsed ul, ul.collapsed li { display: none; } +ul.collapsed.search_uncollapsed { display: block; } +ul.collapsed.search_uncollapsed li { display: list-item; } +li a.toggle { cursor: default; position: relative; left: -5px; top: 4px; text-indent: -999px; width: 10px; height: 9px; margin-left: -10px; display: block; float: left; background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAASCAYAAABb0P4QAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAK8AAACvABQqw0mAAAABx0RVh0U29mdHdhcmUAQWRvYmUgRmlyZXdvcmtzIENTM5jWRgMAAAAVdEVYdENyZWF0aW9uIFRpbWUAMy8xNC8wOeNZPpQAAAE2SURBVDiNrZTBccIwEEXfelIAHUA6CZ24BGaWO+FuzZAK4k6gg5QAdGAq+Bxs2Yqx7BzyL7Llp/VfzZeQhCTc/ezuGzKKnKSzpCxXJM8fwNXda3df5RZETlIt6YUzSQDs93sl8w3wBZxCCE10GM1OcWbWjB2mWgEH4Mfdyxm3PSepBHibgQE2wLe7r4HjEidpnXMYdQPKEMJcsZ4zs2POYQOcaPfwMVOo58zsAdMt18BuoVDPxUJRacELbXv3hUIX2vYmOUvi8C8ydz/ThjXrqKqqLbDIAdsCKBd+Wo7GWa7o9qzOQHVVVXeAbs+yHHCH4aTsaCOQqunmUy1yBUAXkdMIfMlgF5EXLo2OpV/c/Up7jG4hhHcYLgWzAZXUc2b2ixsfvc/RmNNfOXD3Q/oeL9axJE1yT9IOoUu6MGUkAAAAAElFTkSuQmCC) no-repeat bottom left; } +li.collapsed a.toggle { opacity: 0.5; cursor: default; background-position: top left; } +li { color: #888; cursor: pointer; } +li.deprecated { text-decoration: line-through; font-style: italic; } +li.r1 { background: #f0f0f0; } +li.r2 { background: #fafafa; } +li:hover { background: #ddd; } +li small:before { content: "("; } +li small:after { content: ")"; } +li small.search_info { display: none; } +a:link, a:visited { text-decoration: none; color: #05a; } +li.clicked { background: #05a; color: #ccc; } +li.clicked a:link, li.clicked a:visited { color: #eee; } +li.clicked a.toggle { opacity: 0.5; background-position: bottom right; } +li.collapsed.clicked a.toggle { background-position: top right; } +#search input { border: 1px solid #bbb; -moz-border-radius: 3px; -webkit-border-radius: 3px; } +#nav { margin-left: 10px; font-size: 0.9em; display: none; color: #aaa; } +#nav a:link, #nav a:visited { color: #358; } +#nav a:hover { background: transparent; color: #5af; } + +.frames #content h1 { margin-top: 0; } +.frames li { white-space: nowrap; cursor: normal; } +.frames li small { display: block; font-size: 0.8em; } +.frames li small:before { content: ""; } +.frames li small:after { content: ""; } +.frames li small.search_info { display: none; } +.frames #search { width: 170px; position: static; margin: 3px; margin-left: 10px; font-size: 0.9em; color: #888; padding-left: 0; padding-right: 24px; } +.frames #content.insearch #search { background-position: center right; } +.frames #search input { width: 110px; } +.frames #nav { display: block; } + +#full_list.insearch li { display: none; } +#full_list.insearch li.found { display: list-item; padding-left: 10px; } +#full_list.insearch li a.toggle { display: none; } +#full_list.insearch li small.search_info { display: block; } diff --git a/doc/css/style.css b/doc/css/style.css new file mode 100644 index 00000000..60829f7e --- /dev/null +++ b/doc/css/style.css @@ -0,0 +1,322 @@ +body { + padding: 0 20px; + font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; + font-size: 13px; +} +body.frames { padding: 0 5px; } +h1 { font-size: 25px; margin: 1em 0 0.5em; padding-top: 4px; border-top: 1px dotted #d5d5d5; } +h1.noborder { border-top: 0px; margin-top: 0; padding-top: 4px; } +h1.title { margin-bottom: 10px; } +h1.alphaindex { margin-top: 0; font-size: 22px; } +h2 { + padding: 0; + padding-bottom: 3px; + border-bottom: 1px #aaa solid; + font-size: 1.4em; + margin: 1.8em 0 0.5em; +} +h2 small { font-weight: normal; font-size: 0.7em; display: block; float: right; } +.clear { clear: both; } +.inline { display: inline; } +.inline p:first-child { display: inline; } +.docstring h1, .docstring h2, .docstring h3, .docstring h4 { padding: 0; border: 0; border-bottom: 1px dotted #bbb; } +.docstring h1 { font-size: 1.2em; } +.docstring h2 { font-size: 1.1em; } +.docstring h3, .docstring h4 { font-size: 1em; border-bottom: 0; padding-top: 10px; } +.summary_desc .object_link, .docstring .object_link { font-family: monospace; } +.rdoc-term { padding-right: 25px; font-weight: bold; } +.rdoc-list p { margin: 0; padding: 0; margin-bottom: 4px; } + +/* style for <ul> */ +#filecontents li > p, .docstring li > p { margin: 0px; } +#filecontents ul, .docstring ul { padding-left: 20px; } +/* style for <dl> */ +#filecontents dl, .docstring dl { border: 1px solid #ccc; } +#filecontents dt, .docstring dt { background: #ddd; font-weight: bold; padding: 3px 5px; } +#filecontents dd, .docstring dd { padding: 5px 0px; margin-left: 18px; } +#filecontents dd > p, .docstring dd > p { margin: 0px; } + +.note { + color: #222; + -moz-border-radius: 3px; -webkit-border-radius: 3px; + background: #e3e4e3; border: 1px solid #d5d5d5; padding: 7px 10px; + display: block; +} +.note.todo { background: #ffffc5; border-color: #ececaa; } +.note.returns_void { background: #efefef; } +.note.deprecated { background: #ffe5e5; border-color: #e9dada; } +.note.private { background: #ffffc5; border-color: #ececaa; } +.note.title { text-transform: lowercase; padding: 1px 5px; font-size: 0.9em; font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; display: inline; } +.summary_signature + .note.title { margin-left: 7px; } +h1 .note.title { font-size: 0.5em; font-weight: normal; padding: 3px 5px; position: relative; top: -3px; text-transform: capitalize; } +.note.title.constructor { color: #fff; background: #6a98d6; border-color: #6689d6; } +.note.title.writeonly { color: #fff; background: #45a638; border-color: #2da31d; } +.note.title.readonly { color: #fff; background: #6a98d6; border-color: #6689d6; } +.note.title.private { background: #d5d5d5; border-color: #c5c5c5; } +.discussion .note { margin-top: 6px; } +.discussion .note:first-child { margin-top: 0; } + +h3.inherited { + font-style: italic; + font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; + font-weight: normal; + padding: 0; + margin: 0; + margin-top: 12px; + margin-bottom: 3px; + font-size: 13px; +} +p.inherited { + padding: 0; + margin: 0; + margin-left: 25px; +} + +#filecontents dl.box, dl.box { + border: 0; + width: 520px; + font-size: 1em; +} +#filecontents dl.box dt, dl.box dt { + float: left; + display: block; + width: 100px; + margin: 0; + text-align: right; + font-weight: bold; + background: transparent; + border: 1px solid #aaa; + border-width: 1px 0px 0px 1px; + padding: 6px 0; + padding-right: 10px; +} +#filecontents dl.box dd, dl.box dd { + float: left; + display: block; + width: 380px; + margin: 0; + padding: 6px 0; + padding-right: 20px; + border: 1px solid #aaa; + border-width: 1px 1px 0 0; +} +#filecontents dl.box .last, dl.box .last { + border-bottom: 1px solid #aaa; +} +#filecontents dl.box .r1, dl.box .r1 { background: #eee; } + +ul.toplevel { list-style: none; padding-left: 0; font-size: 1.1em; } +#files { padding-left: 15px; font-size: 1.1em; } + +#files { padding: 0; } +#files li { list-style: none; display: inline; padding: 7px 12px; line-height: 35px; } + +dl.constants { margin-left: 40px; } +dl.constants dt { font-weight: bold; font-size: 1.1em; margin-bottom: 5px; } +dl.constants dd { width: 75%; white-space: pre; font-family: monospace; margin-bottom: 18px; } + +.summary_desc { margin-left: 32px; display: block; font-family: sans-serif; } +.summary_desc tt { font-size: 0.9em; } +dl.constants .note { padding: 2px 6px; padding-right: 12px; margin-top: 6px; } +dl.constants .docstring { margin-left: 32px; font-size: 0.9em; font-weight: normal; } +dl.constants .tags { padding-left: 32px; font-size: 0.9em; line-height: 0.8em; } +dl.constants .discussion *:first-child { margin-top: 0; } +dl.constants .discussion *:last-child { margin-bottom: 0; } + +.method_details { border-top: 1px dotted #aaa; margin-top: 15px; padding-top: 0; } +.method_details.first { border: 0; } +p.signature { + font-size: 1.1em; font-weight: normal; font-family: Monaco, Consolas, Courier, monospace; + padding: 6px 10px; margin-top: 18px; + background: #e5e8ff; border: 1px solid #d8d8e5; -moz-border-radius: 3px; -webkit-border-radius: 3px; +} +p.signature tt { font-family: Monaco, Consolas, Courier, monospace; } +p.signature .overload { display: block; } +p.signature .extras { font-weight: normal; font-family: sans-serif; color: #444; font-size: 1em; } +p.signature .aliases { display: block; font-weight: normal; font-size: 0.9em; font-family: sans-serif; margin-top: 0px; color: #555; } +p.signature .aliases .names { font-family: Monaco, Consolas, Courier, monospace; font-weight: bold; color: #000; font-size: 1.2em; } + +.tags h3 { font-size: 1em; margin-bottom: 0; } +.tags ul { margin-top: 5px; padding-left: 30px; list-style: square; } +.tags ul li { margin-bottom: 3px; } +.tags ul .name { font-family: monospace; font-weight: bold; } +.tags ul .note { padding: 3px 6px; } +.tags { margin-bottom: 12px; } + +.tags .examples h3 { margin-bottom: 10px; } +.tags .examples h4 { padding: 0; margin: 0; margin-left: 15px; font-weight: bold; font-size: 0.9em; } + +.tags .overload .overload_item { list-style: none; margin-bottom: 25px; } +.tags .overload .overload_item .signature { + padding: 2px 8px; + background: #e5e8ff; border: 1px solid #d8d8e5; -moz-border-radius: 3px; -webkit-border-radius: 3px; +} +.tags .overload .signature { margin-left: -15px; font-family: monospace; display: block; font-size: 1.1em; } +.tags .overload .docstring { margin-top: 15px; } + +.defines { display: none; } + +#method_missing_details .notice.this { position: relative; top: -8px; color: #888; padding: 0; margin: 0; } + +.showSource { font-size: 0.9em; } +.showSource a:link, .showSource a:visited { text-decoration: none; color: #666; } + +#content a:link, #content a:visited { text-decoration: none; color: #05a; } +#content a:hover { background: #ffffa5; } +.docstring { margin-right: 6em; } + +ul.summary { + list-style: none; + font-family: monospace; + font-size: 1em; + line-height: 1.5em; +} +ul.summary a:link, ul.summary a:visited { + text-decoration: none; font-size: 1.1em; +} +ul.summary li { margin-bottom: 5px; } +.summary .summary_signature { + padding: 1px 10px; + background: #eaeaff; border: 1px solid #dfdfe5; + -moz-border-radius: 3px; -webkit-border-radius: 3px; +} +.summary_signature:hover { background: #eeeeff; cursor: pointer; } +ul.summary.compact li { display: inline-block; margin: 0px 5px 0px 0px; line-height: 2.6em;} +ul.summary.compact .summary_signature { padding: 5px 7px; padding-right: 4px; } +#content .summary_signature:hover a:link, +#content .summary_signature:hover a:visited { + background: transparent; + color: #48f; +} + +p.inherited a { font-family: monospace; font-size: 0.9em; } +p.inherited { word-spacing: 5px; font-size: 1.2em; } + +p.children { font-size: 1.2em; } +p.children a { font-size: 0.9em; } +p.children strong { font-size: 0.8em; } +p.children strong.modules { padding-left: 5px; } + +ul.fullTree { display: none; padding-left: 0; list-style: none; margin-left: 0; margin-bottom: 10px; } +ul.fullTree ul { margin-left: 0; padding-left: 0; list-style: none; } +ul.fullTree li { text-align: center; padding-top: 18px; padding-bottom: 12px; background: url(data:image/gif;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAACXBIWXMAAAsTAAALEwEAmpwYAAAKT2lDQ1BQaG90b3Nob3AgSUNDIHByb2ZpbGUAAHjanVNnVFPpFj333vRCS4iAlEtvUhUIIFJCi4AUkSYqIQkQSoghodkVUcERRUUEG8igiAOOjoCMFVEsDIoK2AfkIaKOg6OIisr74Xuja9a89+bN/rXXPues852zzwfACAyWSDNRNYAMqUIeEeCDx8TG4eQuQIEKJHAAEAizZCFz/SMBAPh+PDwrIsAHvgABeNMLCADATZvAMByH/w/qQplcAYCEAcB0kThLCIAUAEB6jkKmAEBGAYCdmCZTAKAEAGDLY2LjAFAtAGAnf+bTAICd+Jl7AQBblCEVAaCRACATZYhEAGg7AKzPVopFAFgwABRmS8Q5ANgtADBJV2ZIALC3AMDOEAuyAAgMADBRiIUpAAR7AGDIIyN4AISZABRG8lc88SuuEOcqAAB4mbI8uSQ5RYFbCC1xB1dXLh4ozkkXKxQ2YQJhmkAuwnmZGTKBNA/g88wAAKCRFRHgg/P9eM4Ors7ONo62Dl8t6r8G/yJiYuP+5c+rcEAAAOF0ftH+LC+zGoA7BoBt/qIl7gRoXgugdfeLZrIPQLUAoOnaV/Nw+H48PEWhkLnZ2eXk5NhKxEJbYcpXff5nwl/AV/1s+X48/Pf14L7iJIEyXYFHBPjgwsz0TKUcz5IJhGLc5o9H/LcL//wd0yLESWK5WCoU41EScY5EmozzMqUiiUKSKcUl0v9k4t8s+wM+3zUAsGo+AXuRLahdYwP2SycQWHTA4vcAAPK7b8HUKAgDgGiD4c93/+8//UegJQCAZkmScQAAXkQkLlTKsz/HCAAARKCBKrBBG/TBGCzABhzBBdzBC/xgNoRCJMTCQhBCCmSAHHJgKayCQiiGzbAdKmAv1EAdNMBRaIaTcA4uwlW4Dj1wD/phCJ7BKLyBCQRByAgTYSHaiAFiilgjjggXmYX4IcFIBBKLJCDJiBRRIkuRNUgxUopUIFVIHfI9cgI5h1xGupE7yAAygvyGvEcxlIGyUT3UDLVDuag3GoRGogvQZHQxmo8WoJvQcrQaPYw2oefQq2gP2o8+Q8cwwOgYBzPEbDAuxsNCsTgsCZNjy7EirAyrxhqwVqwDu4n1Y8+xdwQSgUXACTYEd0IgYR5BSFhMWE7YSKggHCQ0EdoJNwkDhFHCJyKTqEu0JroR+cQYYjIxh1hILCPWEo8TLxB7iEPENyQSiUMyJ7mQAkmxpFTSEtJG0m5SI+ksqZs0SBojk8naZGuyBzmULCAryIXkneTD5DPkG+Qh8lsKnWJAcaT4U+IoUspqShnlEOU05QZlmDJBVaOaUt2ooVQRNY9aQq2htlKvUYeoEzR1mjnNgxZJS6WtopXTGmgXaPdpr+h0uhHdlR5Ol9BX0svpR+iX6AP0dwwNhhWDx4hnKBmbGAcYZxl3GK+YTKYZ04sZx1QwNzHrmOeZD5lvVVgqtip8FZHKCpVKlSaVGyovVKmqpqreqgtV81XLVI+pXlN9rkZVM1PjqQnUlqtVqp1Q61MbU2epO6iHqmeob1Q/pH5Z/YkGWcNMw09DpFGgsV/jvMYgC2MZs3gsIWsNq4Z1gTXEJrHN2Xx2KruY/R27iz2qqaE5QzNKM1ezUvOUZj8H45hx+Jx0TgnnKKeX836K3hTvKeIpG6Y0TLkxZVxrqpaXllirSKtRq0frvTau7aedpr1Fu1n7gQ5Bx0onXCdHZ4/OBZ3nU9lT3acKpxZNPTr1ri6qa6UbobtEd79up+6Ynr5egJ5Mb6feeb3n+hx9L/1U/W36p/VHDFgGswwkBtsMzhg8xTVxbzwdL8fb8VFDXcNAQ6VhlWGX4YSRudE8o9VGjUYPjGnGXOMk423GbcajJgYmISZLTepN7ppSTbmmKaY7TDtMx83MzaLN1pk1mz0x1zLnm+eb15vft2BaeFostqi2uGVJsuRaplnutrxuhVo5WaVYVVpds0atna0l1rutu6cRp7lOk06rntZnw7Dxtsm2qbcZsOXYBtuutm22fWFnYhdnt8Wuw+6TvZN9un2N/T0HDYfZDqsdWh1+c7RyFDpWOt6azpzuP33F9JbpL2dYzxDP2DPjthPLKcRpnVOb00dnF2e5c4PziIuJS4LLLpc+Lpsbxt3IveRKdPVxXeF60vWdm7Obwu2o26/uNu5p7ofcn8w0nymeWTNz0MPIQ+BR5dE/C5+VMGvfrH5PQ0+BZ7XnIy9jL5FXrdewt6V3qvdh7xc+9j5yn+M+4zw33jLeWV/MN8C3yLfLT8Nvnl+F30N/I/9k/3r/0QCngCUBZwOJgUGBWwL7+Hp8Ib+OPzrbZfay2e1BjKC5QRVBj4KtguXBrSFoyOyQrSH355jOkc5pDoVQfujW0Adh5mGLw34MJ4WHhVeGP45wiFga0TGXNXfR3ENz30T6RJZE3ptnMU85ry1KNSo+qi5qPNo3ujS6P8YuZlnM1VidWElsSxw5LiquNm5svt/87fOH4p3iC+N7F5gvyF1weaHOwvSFpxapLhIsOpZATIhOOJTwQRAqqBaMJfITdyWOCnnCHcJnIi/RNtGI2ENcKh5O8kgqTXqS7JG8NXkkxTOlLOW5hCepkLxMDUzdmzqeFpp2IG0yPTq9MYOSkZBxQqohTZO2Z+pn5mZ2y6xlhbL+xW6Lty8elQfJa7OQrAVZLQq2QqboVFoo1yoHsmdlV2a/zYnKOZarnivN7cyzytuQN5zvn//tEsIS4ZK2pYZLVy0dWOa9rGo5sjxxedsK4xUFK4ZWBqw8uIq2Km3VT6vtV5eufr0mek1rgV7ByoLBtQFr6wtVCuWFfevc1+1dT1gvWd+1YfqGnRs+FYmKrhTbF5cVf9go3HjlG4dvyr+Z3JS0qavEuWTPZtJm6ebeLZ5bDpaql+aXDm4N2dq0Dd9WtO319kXbL5fNKNu7g7ZDuaO/PLi8ZafJzs07P1SkVPRU+lQ27tLdtWHX+G7R7ht7vPY07NXbW7z3/T7JvttVAVVN1WbVZftJ+7P3P66Jqun4lvttXa1ObXHtxwPSA/0HIw6217nU1R3SPVRSj9Yr60cOxx++/p3vdy0NNg1VjZzG4iNwRHnk6fcJ3/ceDTradox7rOEH0x92HWcdL2pCmvKaRptTmvtbYlu6T8w+0dbq3nr8R9sfD5w0PFl5SvNUyWna6YLTk2fyz4ydlZ19fi753GDborZ752PO32oPb++6EHTh0kX/i+c7vDvOXPK4dPKy2+UTV7hXmq86X23qdOo8/pPTT8e7nLuarrlca7nuer21e2b36RueN87d9L158Rb/1tWeOT3dvfN6b/fF9/XfFt1+cif9zsu72Xcn7q28T7xf9EDtQdlD3YfVP1v+3Njv3H9qwHeg89HcR/cGhYPP/pH1jw9DBY+Zj8uGDYbrnjg+OTniP3L96fynQ89kzyaeF/6i/suuFxYvfvjV69fO0ZjRoZfyl5O/bXyl/erA6xmv28bCxh6+yXgzMV70VvvtwXfcdx3vo98PT+R8IH8o/2j5sfVT0Kf7kxmTk/8EA5jz/GMzLdsAAAAgY0hSTQAAeiUAAICDAAD5/wAAgOkAAHUwAADqYAAAOpgAABdvkl/FRgAAAHtJREFUeNqMzrEJAkEURdGzuhgZbSoYWcAWoBVsB4JgZAGmphsZCZYzTQgWNCYrDN9RvMmHx+X916SUBFbo8CzD1idXrLErw1mQttgXtyrOcQ/Ny5p4Qh+2XqLYYazsPWNTiuMkRxa4vcV+evuNAUOLIx5+c2hyzv7hNQC67Q+/HHmlEwAAAABJRU5ErkJggg==) no-repeat top center; } +ul.fullTree li:first-child { padding-top: 0; background: transparent; } +ul.fullTree li:last-child { padding-bottom: 0; } +.showAll ul.fullTree { display: block; } +.showAll .inheritName { display: none; } + +#search { position: absolute; right: 14px; top: 0px; } +#search a:link, #search a:visited { + display: block; float: left; margin-right: 4px; + padding: 8px 10px; text-decoration: none; color: #05a; + border: 1px solid #d8d8e5; + -moz-border-radius-bottomleft: 3px; -moz-border-radius-bottomright: 3px; + -webkit-border-bottom-left-radius: 3px; -webkit-border-bottom-right-radius: 3px; + background: #eaf0ff; + -webkit-box-shadow: -1px 1px 3px #ddd; +} +#search a:hover { background: #f5faff; color: #06b; } +#search a.active { + background: #568; padding-bottom: 20px; color: #fff; border: 1px solid #457; + -moz-border-radius-topleft: 5px; -moz-border-radius-topright: 5px; + -webkit-border-top-left-radius: 5px; -webkit-border-top-right-radius: 5px; +} +#search a.inactive { color: #999; } +.frames #search { display: none; } +.inheritanceTree, .toggleDefines { float: right; } + +#menu { font-size: 1.3em; color: #bbb; top: -5px; position: relative; } +#menu .title, #menu a { font-size: 0.7em; } +#menu .title a { font-size: 1em; } +#menu .title { color: #555; } +#menu a:link, #menu a:visited { color: #333; text-decoration: none; border-bottom: 1px dotted #bbd; } +#menu a:hover { color: #05a; } +#menu .noframes { display: none; } +.frames #menu .noframes { display: inline; float: right; } + +#footer { margin-top: 15px; border-top: 1px solid #ccc; text-align: center; padding: 7px 0; color: #999; } +#footer a:link, #footer a:visited { color: #444; text-decoration: none; border-bottom: 1px dotted #bbd; } +#footer a:hover { color: #05a; } + +#listing ul.alpha { font-size: 1.1em; } +#listing ul.alpha { margin: 0; padding: 0; padding-bottom: 10px; list-style: none; } +#listing ul.alpha li.letter { font-size: 1.4em; padding-bottom: 10px; } +#listing ul.alpha ul { margin: 0; padding-left: 15px; } +#listing ul small { color: #666; font-size: 0.7em; } + +li.r1 { background: #f0f0f0; } +li.r2 { background: #fafafa; } + +#search_frame { + z-index: 9999; + background: #fff; + display: none; + position: absolute; + top: 36px; + right: 18px; + width: 500px; + height: 80%; + overflow-y: scroll; + border: 1px solid #999; + border-collapse: collapse; + -webkit-box-shadow: -7px 5px 25px #aaa; + -moz-box-shadow: -7px 5px 25px #aaa; + -moz-border-radius: 2px; + -webkit-border-radius: 2px; +} + +#content ul.summary li.deprecated .summary_signature a:link, +#content ul.summary li.deprecated .summary_signature a:visited { text-decoration: line-through; font-style: italic; } + +#toc { + padding: 20px; padding-right: 30px; border: 1px solid #ddd; float: right; background: #fff; margin-left: 20px; margin-bottom: 20px; + max-width: 300px; + -webkit-box-shadow: -2px 2px 6px #bbb; + -moz-box-shadow: -2px 2px 6px #bbb; + z-index: 5000; + position: relative; +} +#toc.nofloat { float: none; max-width: none; border: none; padding: 0; margin: 20px 0; -webkit-box-shadow: none; -moz-box-shadow: none; } +#toc.nofloat.hidden { padding: 0; background: 0; margin-bottom: 5px; } +#toc .title { margin: 0; } +#toc ol { padding-left: 1.8em; } +#toc li { font-size: 1.1em; line-height: 1.7em; } +#toc > ol > li { font-size: 1.1em; font-weight: bold; } +#toc ol > ol { font-size: 0.9em; } +#toc ol ol > ol { padding-left: 2.3em; } +#toc ol + li { margin-top: 0.3em; } +#toc.hidden { padding: 10px; background: #f6f6f6; -webkit-box-shadow: none; -moz-box-shadow: none; } +#filecontents h1 + #toc.nofloat { margin-top: 0; } + +/* syntax highlighting */ +.source_code { display: none; padding: 3px 8px; border-left: 8px solid #ddd; margin-top: 5px; } +#filecontents pre.code, .docstring pre.code, .source_code pre { font-family: monospace; } +#filecontents pre.code, .docstring pre.code { display: block; } +.source_code .lines { padding-right: 12px; color: #555; text-align: right; } +#filecontents pre.code, .docstring pre.code, +.tags .example { padding: 5px 12px; margin-top: 4px; border: 1px solid #eef; background: #f5f5ff; } +pre.code { color: #000; } +pre.code .info.file { color: #555; } +pre.code .val { color: #036A07; } +pre.code .tstring_content, +pre.code .heredoc_beg, pre.code .heredoc_end, +pre.code .qwords_beg, pre.code .qwords_end, +pre.code .tstring, pre.code .dstring { color: #036A07; } +pre.code .fid, pre.code .id.new, pre.code .id.to_s, +pre.code .id.to_sym, pre.code .id.to_f, +pre.code .dot + pre.code .id, +pre.code .id.to_i pre.code .id.each { color: #0085FF; } +pre.code .comment { color: #0066FF; } +pre.code .const, pre.code .constant { color: #585CF6; } +pre.code .symbol { color: #C5060B; } +pre.code .kw, +pre.code .label, +pre.code .id.require, +pre.code .id.extend, +pre.code .id.include { color: #0000FF; } +pre.code .ivar { color: #318495; } +pre.code .gvar, +pre.code .id.backref, +pre.code .id.nth_ref { color: #6D79DE; } +pre.code .regexp, .dregexp { color: #036A07; } +pre.code a { border-bottom: 1px dotted #bbf; } diff --git a/doc/file.README.html b/doc/file.README.html new file mode 100644 index 00000000..81b79b35 --- /dev/null +++ b/doc/file.README.html @@ -0,0 +1,136 @@ +<!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> + File: README + + — 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" title="Index">Index</a> » + <span class="title">File: README</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"><div id='filecontents'><h1>Axlsx: Office Open XML Spreadsheet Generation</h1> + +<p><strong>IRC</strong>: <a href="irc://irc.freenode.net/axlsx">irc.freenode.net / #axlsx</a> <br/> +<strong>Git</strong>: <a href="http://github.com/randym/axlsx">http://github.com/randym/axlsx</a> <br/> +<strong>Author</strong>: Randy Morgan +<strong>Copyright</strong>: 2011 <br/> +<strong>License</strong>: MIT License <br/> +<strong>Latest Version</strong>: 1.0.0 +<strong>Release Date</strong>: November 20th 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> + +<h2>Feature List</h2> + +<p>**1. Author xlsx documents: Axlsx is made to let you easily and quickly generate profesional xlsx based reports that can be validated before serialiation.</p> + +<p>**2. Generate 3D Pie and Bar Charts: With Axlsx chart generation and management is as easy as a few lines of code. You can build charts based off data in your worksheet or generate charts without any data in your sheet at all.</p> + +<p>**3. Custom Styles: With guaranteed document validity, you can style borders, alignment, fills, fonts, and number formats in a single line of code. Those styles can be applied to an entire row, or a single cell anywhere in your workbook.</p> + +<p>**4. Automatic type support: Axlsx will automatically determine the type of data you are generating. In this release Float, Integer, String and Time types are automatically identified and serialized to your spreadsheet.</p> + +<h2>Installing</h2> + +<p>To install Axlsx, use the following command:</p> + +<pre class="code">$ <span class='gem identifier id'>gem</span> <span class='install identifier id'>install</span> <span class='axlsx identifier id'>axlsx</span> +</pre> + +<h2>Usage</h2> + +<p>Generating a workbook with styles and a chart: + p = Axlsx::Package.new do |package|</p> + +<pre class="code"><span class='package identifier id'>package</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"First"</span><span class='comma token'>,</span> <span class='string val'>"Second"</span><span class='comma token'>,</span> <span class='string val'>"Third"</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>3</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Bar3DChart constant id'>Bar3DChart</span><span class='comma token'>,</span> <span class='symbol val'>:start_at</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>2</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:end_at</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>5</span><span class='comma token'>,</span> <span class='integer val'>15</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:title=</span><span class='gt op'>></span><span class='string val'>"example 1: Chart"</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='chart identifier id'>chart</span><span class='bitor op'>|</span> + <span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='add_series identifier id'>add_series</span> <span class='symbol val'>:data=</span><span class='gt op'>></span><span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='comma token'>,</span> <span class='symbol val'>:labels=</span><span class='gt op'>></span> <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +<span class='package identifier id'>package</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>"example1.xlsx"</span><span class='rparen token'>)</span> +</pre> + +<p> end</p> + +<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> + +<p> yard server -g</p> + +<h3>Specs</h3> + +<p>This gem has 100% test coverage. To execute tests for this gem, simply run rake in the gem directory.</p> + +<h2>Changelog</h2> + +<ul> +<li><strong>October.10.11</strong>: 0.1.0 release</li> +</ul> + + +<h2>Copyright</h2> + +<p>Axlsx © 2011 by <a href="mailto:[email protected]">Randy Morgan</a>. Axlsx is +licensed under the MIT license. Please see the <a href="file.LICENSE.html" title="LICENSE">LICENSE</a> document for more information.</p> +</div></div> + + <div id="footer"> + Generated on Sun Nov 20 23:43: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> + + </body> +</html>
\ No newline at end of file diff --git a/doc/file_list.html b/doc/file_list.html new file mode 100644 index 00000000..2ea5474e --- /dev/null +++ b/doc/file_list.html @@ -0,0 +1,49 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <link rel="stylesheet" href="css/full_list.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" src="js/jquery.js"></script> + + <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script> + + + <base id="base_target" target="_parent" /> + </head> + <body> + <script type="text/javascript" charset="utf-8"> + if (window.top.frames.main) { + document.getElementById('base_target').target = 'main'; + document.body.className = 'frames'; + } + </script> + <div id="content"> + <h1 id="full_list_header">File List</h1> + <div id="nav"> + + <a target="_self" href="class_list.html">Classes</a> + + <a target="_self" href="method_list.html">Methods</a> + + <a target="_self" href="file_list.html">Files</a> + + </div> + <div id="search">Search: <input type="text" /></div> + + <ul id="full_list" class="files"> + + + <li class="r1"><a href="index.html" title="README">README</a></li> + + + </ul> + </div> + </body> +</html> diff --git a/doc/frames.html b/doc/frames.html new file mode 100644 index 00000000..4cc52cb7 --- /dev/null +++ b/doc/frames.html @@ -0,0 +1,13 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.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>Documentation by YARD 0.7.3</title> +</head> +<frameset cols="20%,*"> + <frame name="list" src="class_list.html" /> + <frame name="main" src="index.html" /> +</frameset> +</html> diff --git a/doc/index.html b/doc/index.html new file mode 100644 index 00000000..81b79b35 --- /dev/null +++ b/doc/index.html @@ -0,0 +1,136 @@ +<!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> + File: README + + — 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" title="Index">Index</a> » + <span class="title">File: README</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"><div id='filecontents'><h1>Axlsx: Office Open XML Spreadsheet Generation</h1> + +<p><strong>IRC</strong>: <a href="irc://irc.freenode.net/axlsx">irc.freenode.net / #axlsx</a> <br/> +<strong>Git</strong>: <a href="http://github.com/randym/axlsx">http://github.com/randym/axlsx</a> <br/> +<strong>Author</strong>: Randy Morgan +<strong>Copyright</strong>: 2011 <br/> +<strong>License</strong>: MIT License <br/> +<strong>Latest Version</strong>: 1.0.0 +<strong>Release Date</strong>: November 20th 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> + +<h2>Feature List</h2> + +<p>**1. Author xlsx documents: Axlsx is made to let you easily and quickly generate profesional xlsx based reports that can be validated before serialiation.</p> + +<p>**2. Generate 3D Pie and Bar Charts: With Axlsx chart generation and management is as easy as a few lines of code. You can build charts based off data in your worksheet or generate charts without any data in your sheet at all.</p> + +<p>**3. Custom Styles: With guaranteed document validity, you can style borders, alignment, fills, fonts, and number formats in a single line of code. Those styles can be applied to an entire row, or a single cell anywhere in your workbook.</p> + +<p>**4. Automatic type support: Axlsx will automatically determine the type of data you are generating. In this release Float, Integer, String and Time types are automatically identified and serialized to your spreadsheet.</p> + +<h2>Installing</h2> + +<p>To install Axlsx, use the following command:</p> + +<pre class="code">$ <span class='gem identifier id'>gem</span> <span class='install identifier id'>install</span> <span class='axlsx identifier id'>axlsx</span> +</pre> + +<h2>Usage</h2> + +<p>Generating a workbook with styles and a chart: + p = Axlsx::Package.new do |package|</p> + +<pre class="code"><span class='package identifier id'>package</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='bitor op'>|</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='string val'>"First"</span><span class='comma token'>,</span> <span class='string val'>"Second"</span><span class='comma token'>,</span> <span class='string val'>"Third"</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='integer val'>2</span><span class='comma token'>,</span> <span class='integer val'>3</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span> + <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Bar3DChart constant id'>Bar3DChart</span><span class='comma token'>,</span> <span class='symbol val'>:start_at</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>2</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:end_at</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>5</span><span class='comma token'>,</span> <span class='integer val'>15</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:title=</span><span class='gt op'>></span><span class='string val'>"example 1: Chart"</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='chart identifier id'>chart</span><span class='bitor op'>|</span> + <span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='add_series identifier id'>add_series</span> <span class='symbol val'>:data=</span><span class='gt op'>></span><span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='comma token'>,</span> <span class='symbol val'>:labels=</span><span class='gt op'>></span> <span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +<span class='package identifier id'>package</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='string val'>"example1.xlsx"</span><span class='rparen token'>)</span> +</pre> + +<p> end</p> + +<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> + +<p> yard server -g</p> + +<h3>Specs</h3> + +<p>This gem has 100% test coverage. To execute tests for this gem, simply run rake in the gem directory.</p> + +<h2>Changelog</h2> + +<ul> +<li><strong>October.10.11</strong>: 0.1.0 release</li> +</ul> + + +<h2>Copyright</h2> + +<p>Axlsx © 2011 by <a href="mailto:[email protected]">Randy Morgan</a>. Axlsx is +licensed under the MIT license. Please see the <a href="file.LICENSE.html" title="LICENSE">LICENSE</a> document for more information.</p> +</div></div> + + <div id="footer"> + Generated on Sun Nov 20 23:43: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> + + </body> +</html>
\ No newline at end of file diff --git a/doc/js/app.js b/doc/js/app.js new file mode 100644 index 00000000..97095cbf --- /dev/null +++ b/doc/js/app.js @@ -0,0 +1,205 @@ +function createSourceLinks() { + $('.method_details_list .source_code'). + before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>"); + $('.toggleSource').toggle(function() { + $(this).parent().next().slideDown(100); + $(this).text("Hide source"); + }, + function() { + $(this).parent().next().slideUp(100); + $(this).text("View source"); + }); +} + +function createDefineLinks() { + var tHeight = 0; + $('.defines').after(" <a href='#' class='toggleDefines'>more...</a>"); + $('.toggleDefines').toggle(function() { + tHeight = $(this).parent().prev().height(); + $(this).prev().show(); + $(this).parent().prev().height($(this).parent().height()); + $(this).text("(less)"); + }, + function() { + $(this).prev().hide(); + $(this).parent().prev().height(tHeight); + $(this).text("more..."); + }); +} + +function createFullTreeLinks() { + var tHeight = 0; + $('.inheritanceTree').toggle(function() { + tHeight = $(this).parent().prev().height(); + $(this).parent().toggleClass('showAll'); + $(this).text("(hide)"); + $(this).parent().prev().height($(this).parent().height()); + }, + function() { + $(this).parent().toggleClass('showAll'); + $(this).parent().prev().height(tHeight); + $(this).text("show all"); + }); +} + +function fixBoxInfoHeights() { + $('dl.box dd.r1, dl.box dd.r2').each(function() { + $(this).prev().height($(this).height()); + }); +} + +function searchFrameLinks() { + $('#method_list_link').click(function() { + toggleSearchFrame(this, relpath + 'method_list.html'); + }); + + $('#class_list_link').click(function() { + toggleSearchFrame(this, relpath + 'class_list.html'); + }); + + $('#file_list_link').click(function() { + toggleSearchFrame(this, relpath + 'file_list.html'); + }); +} + +function toggleSearchFrame(id, link) { + var frame = $('#search_frame'); + $('#search a').removeClass('active').addClass('inactive'); + if (frame.attr('src') == link && frame.css('display') != "none") { + frame.slideUp(100); + $('#search a').removeClass('active inactive'); + } + else { + $(id).addClass('active').removeClass('inactive'); + frame.attr('src', link).slideDown(100); + } +} + +function linkSummaries() { + $('.summary_signature').click(function() { + document.location = $(this).find('a').attr('href'); + }); +} + +function framesInit() { + if (window.top.frames.main) { + document.body.className = 'frames'; + $('#menu .noframes a').attr('href', document.location); + $('html head title', window.parent.document).text($('html head title').text()); + } +} + +function keyboardShortcuts() { + if (window.top.frames.main) return; + $(document).keypress(function(evt) { + if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return; + if (typeof evt.target !== "undefined" && + (evt.target.nodeName == "INPUT" || + evt.target.nodeName == "TEXTAREA")) return; + switch (evt.charCode) { + case 67: case 99: $('#class_list_link').click(); break; // 'c' + case 77: case 109: $('#method_list_link').click(); break; // 'm' + case 70: case 102: $('#file_list_link').click(); break; // 'f' + default: break; + } + }); +} + +function summaryToggle() { + $('.summary_toggle').click(function() { + localStorage.summaryCollapsed = $(this).text(); + $(this).text($(this).text() == "collapse" ? "expand" : "collapse"); + var next = $(this).parent().parent().next(); + if (next.hasClass('compact')) { + next.toggle(); + next.next().toggle(); + } + else if (next.hasClass('summary')) { + var list = $('<ul class="summary compact" />'); + list.html(next.html()); + list.find('.summary_desc, .note').remove(); + list.find('a').each(function() { + $(this).html($(this).find('strong').html()); + $(this).parent().html($(this)[0].outerHTML); + }); + next.before(list); + next.toggle(); + } + return false; + }); + if (localStorage) { + if (localStorage.summaryCollapsed == "collapse") $('.summary_toggle').click(); + else localStorage.summaryCollapsed = "expand"; + } +} + +function fixOutsideWorldLinks() { + $('a').each(function() { + if (window.location.host != this.host) this.target = '_parent'; + }); +} + +function generateTOC() { + if ($('#filecontents').length === 0) return; + var _toc = $('<ol class="top"></ol>'); + var show = false; + var toc = _toc; + var counter = 0; + var tags = ['h2', 'h3', 'h4', 'h5', 'h6']; + var i; + if ($('#filecontents h1').length > 1) tags.unshift('h1'); + for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; } + var lastTag = parseInt(tags[0][1], 10); + $(tags.join(', ')).each(function() { + if (this.id == "filecontents") return; + show = true; + var thisTag = parseInt(this.tagName[1], 10); + if (this.id.length === 0) { + var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_'); + if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; } + this.id = proposedId; + } + if (thisTag > lastTag) { + for (i = 0; i < thisTag - lastTag; i++) { + var tmp = $('<ol/>'); toc.append(tmp); toc = tmp; + } + } + if (thisTag < lastTag) { + for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent(); + } + toc.append('<li><a href="#' + this.id + '">' + $(this).text() + '</a></li>'); + lastTag = thisTag; + }); + if (!show) return; + html = '<div id="toc"><p class="title"><a class="hide_toc" href="#"><strong>Table of Contents</strong></a> <small>(<a href="#" class="float_toc">left</a>)</small></p></div>'; + $('#content').prepend(html); + $('#toc').append(_toc); + $('#toc .hide_toc').toggle(function() { + $('#toc .top').slideUp('fast'); + $('#toc').toggleClass('hidden'); + $('#toc .title small').toggle(); + }, function() { + $('#toc .top').slideDown('fast'); + $('#toc').toggleClass('hidden'); + $('#toc .title small').toggle(); + }); + $('#toc .float_toc').toggle(function() { + $(this).text('float'); + $('#toc').toggleClass('nofloat'); + }, function() { + $(this).text('left'); + $('#toc').toggleClass('nofloat'); + }); +} + +$(framesInit); +$(createSourceLinks); +$(createDefineLinks); +$(createFullTreeLinks); +$(fixBoxInfoHeights); +$(searchFrameLinks); +$(linkSummaries); +$(keyboardShortcuts); +$(summaryToggle); +$(fixOutsideWorldLinks); +$(generateTOC);
\ No newline at end of file diff --git a/doc/js/full_list.js b/doc/js/full_list.js new file mode 100644 index 00000000..c6531a24 --- /dev/null +++ b/doc/js/full_list.js @@ -0,0 +1,167 @@ +var inSearch = null; +var searchIndex = 0; +var searchCache = []; +var searchString = ''; +var regexSearchString = ''; +var caseSensitiveMatch = false; + +RegExp.escape = function(text) { + return text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&"); +} + +function fullListSearch() { + // generate cache + searchCache = []; + $('#full_list li').each(function() { + var link = $(this).find('.object_link a'); + var fullName = link.attr('title').split(' ')[0]; + searchCache.push({name:link.text(), fullName:fullName, node:$(this), link:link}); + }); + + $('#search input').keyup(function() { + searchString = this.value; + caseSensitiveMatch = searchString.match(/[A-Z]/) != null; + regexSearchString = RegExp.escape(searchString); + if (caseSensitiveMatch) { + regexSearchString += "|" + + $.map(searchString.split(''), function(e) { return RegExp.escape(e); }). + join('.+?'); + } + if (searchString === "") { + clearTimeout(inSearch); + inSearch = null; + $('ul .search_uncollapsed').removeClass('search_uncollapsed'); + $('#full_list, #content').removeClass('insearch'); + $('#full_list li').removeClass('found').each(function() { + + var link = $(this).find('.object_link a'); + link.text(link.text()); + }); + if (clicked) { + clicked.parents('ul').each(function() { + $(this).removeClass('collapsed').prev().removeClass('collapsed'); + }); + } + highlight(); + } + else { + if (inSearch) clearTimeout(inSearch); + searchIndex = 0; + lastRowClass = ''; + $('#full_list, #content').addClass('insearch'); + $('#noresults').text(''); + searchItem(); + } + }); + + $('#search input').focus(); + $('#full_list').after("<div id='noresults'></div>"); +} + +var lastRowClass = ''; +function searchItem() { + for (var i = 0; i < searchCache.length / 50; i++) { + var item = searchCache[searchIndex]; + var searchName = (searchString.indexOf('::') != -1 ? item.fullName : item.name); + var matchString = regexSearchString; + var matchRegexp = new RegExp(matchString, caseSensitiveMatch ? "" : "i"); + if (searchName.match(matchRegexp) == null) { + item.node.removeClass('found'); + } + else { + item.node.css('padding-left', '10px').addClass('found'); + item.node.parents().addClass('search_uncollapsed'); + item.node.removeClass(lastRowClass).addClass(lastRowClass == 'r1' ? 'r2' : 'r1'); + lastRowClass = item.node.hasClass('r1') ? 'r1' : 'r2'; + item.link.html(item.name.replace(matchRegexp, "<strong>$&</strong>")); + } + + if (searchCache.length === searchIndex + 1) { + searchDone(); + return; + } + else { + searchIndex++; + } + } + inSearch = setTimeout('searchItem()', 0); +} + +function searchDone() { + highlight(true); + if ($('#full_list li:visible').size() === 0) { + $('#noresults').text('No results were found.').hide().fadeIn(); + } + else { + $('#noresults').text(''); + } + $('#content').removeClass('insearch'); + clearTimeout(inSearch); + inSearch = null; +} + +clicked = null; +function linkList() { + $('#full_list li, #full_list li a:last').click(function(evt) { + if ($(this).hasClass('toggle')) return true; + if (this.tagName.toLowerCase() == "li") { + var toggle = $(this).children('a.toggle'); + if (toggle.size() > 0 && evt.pageX < toggle.offset().left) { + toggle.click(); + return false; + } + } + if (clicked) clicked.removeClass('clicked'); + var win = window.top.frames.main ? window.top.frames.main : window.parent; + if (this.tagName.toLowerCase() == "a") { + clicked = $(this).parent('li').addClass('clicked'); + win.location = this.href; + } + else { + clicked = $(this).addClass('clicked'); + win.location = $(this).find('a:last').attr('href'); + } + return false; + }); +} + +function collapse() { + if (!$('#full_list').hasClass('class')) return; + $('#full_list.class a.toggle').click(function() { + $(this).parent().toggleClass('collapsed').next().toggleClass('collapsed'); + highlight(); + return false; + }); + $('#full_list.class ul').each(function() { + $(this).addClass('collapsed').prev().addClass('collapsed'); + }); + $('#full_list.class').children().removeClass('collapsed'); + highlight(); +} + +function highlight(no_padding) { + var n = 1; + $('#full_list li:visible').each(function() { + var next = n == 1 ? 2 : 1; + $(this).removeClass("r" + next).addClass("r" + n); + if (!no_padding && $('#full_list').hasClass('class')) { + $(this).css('padding-left', (10 + $(this).parents('ul').size() * 15) + 'px'); + } + n = next; + }); +} + +function escapeShortcut() { + $(document).keydown(function(evt) { + if (evt.which == 27) { + $('#search_frame', window.top.document).slideUp(100); + $('#search a', window.top.document).removeClass('active inactive'); + $(window.top).focus(); + } + }); +} + +$(escapeShortcut); +$(fullListSearch); +$(linkList); +$(collapse); diff --git a/doc/js/jquery.js b/doc/js/jquery.js new file mode 100644 index 00000000..f78f96a1 --- /dev/null +++ b/doc/js/jquery.js @@ -0,0 +1,16 @@ +/*! + * jQuery JavaScript Library v1.5.2 + * http://jquery.com/ + * + * Copyright 2011, John Resig + * Dual licensed under the MIT or GPL Version 2 licenses. + * http://jquery.org/license + * + * Includes Sizzle.js + * http://sizzlejs.com/ + * Copyright 2011, The Dojo Foundation + * Released under the MIT, BSD, and GPL Licenses. + * + * Date: Thu Mar 31 15:28:23 2011 -0400 + */ +(function(a,b){function ci(a){return d.isWindow(a)?a:a.nodeType===9?a.defaultView||a.parentWindow:!1}function cf(a){if(!b_[a]){var b=d("<"+a+">").appendTo("body"),c=b.css("display");b.remove();if(c==="none"||c==="")c="block";b_[a]=c}return b_[a]}function ce(a,b){var c={};d.each(cd.concat.apply([],cd.slice(0,b)),function(){c[this]=a});return c}function b$(){try{return new a.ActiveXObject("Microsoft.XMLHTTP")}catch(b){}}function bZ(){try{return new a.XMLHttpRequest}catch(b){}}function bY(){d(a).unload(function(){for(var a in bW)bW[a](0,1)})}function bS(a,c){a.dataFilter&&(c=a.dataFilter(c,a.dataType));var e=a.dataTypes,f={},g,h,i=e.length,j,k=e[0],l,m,n,o,p;for(g=1;g<i;g++){if(g===1)for(h in a.converters)typeof h==="string"&&(f[h.toLowerCase()]=a.converters[h]);l=k,k=e[g];if(k==="*")k=l;else if(l!=="*"&&l!==k){m=l+" "+k,n=f[m]||f["* "+k];if(!n){p=b;for(o in f){j=o.split(" ");if(j[0]===l||j[0]==="*"){p=f[j[1]+" "+k];if(p){o=f[o],o===!0?n=p:p===!0&&(n=o);break}}}}!n&&!p&&d.error("No conversion from "+m.replace(" "," to ")),n!==!0&&(c=n?n(c):p(o(c)))}}return c}function bR(a,c,d){var e=a.contents,f=a.dataTypes,g=a.responseFields,h,i,j,k;for(i in g)i in d&&(c[g[i]]=d[i]);while(f[0]==="*")f.shift(),h===b&&(h=a.mimeType||c.getResponseHeader("content-type"));if(h)for(i in e)if(e[i]&&e[i].test(h)){f.unshift(i);break}if(f[0]in d)j=f[0];else{for(i in d){if(!f[0]||a.converters[i+" "+f[0]]){j=i;break}k||(k=i)}j=j||k}if(j){j!==f[0]&&f.unshift(j);return d[j]}}function bQ(a,b,c,e){if(d.isArray(b)&&b.length)d.each(b,function(b,f){c||bs.test(a)?e(a,f):bQ(a+"["+(typeof f==="object"||d.isArray(f)?b:"")+"]",f,c,e)});else if(c||b==null||typeof b!=="object")e(a,b);else if(d.isArray(b)||d.isEmptyObject(b))e(a,"");else for(var f in b)bQ(a+"["+f+"]",b[f],c,e)}function bP(a,c,d,e,f,g){f=f||c.dataTypes[0],g=g||{},g[f]=!0;var h=a[f],i=0,j=h?h.length:0,k=a===bJ,l;for(;i<j&&(k||!l);i++)l=h[i](c,d,e),typeof l==="string"&&(!k||g[l]?l=b:(c.dataTypes.unshift(l),l=bP(a,c,d,e,l,g)));(k||!l)&&!g["*"]&&(l=bP(a,c,d,e,"*",g));return l}function bO(a){return function(b,c){typeof b!=="string"&&(c=b,b="*");if(d.isFunction(c)){var e=b.toLowerCase().split(bD),f=0,g=e.length,h,i,j;for(;f<g;f++)h=e[f],j=/^\+/.test(h),j&&(h=h.substr(1)||"*"),i=a[h]=a[h]||[],i[j?"unshift":"push"](c)}}}function bq(a,b,c){var e=b==="width"?bk:bl,f=b==="width"?a.offsetWidth:a.offsetHeight;if(c==="border")return f;d.each(e,function(){c||(f-=parseFloat(d.css(a,"padding"+this))||0),c==="margin"?f+=parseFloat(d.css(a,"margin"+this))||0:f-=parseFloat(d.css(a,"border"+this+"Width"))||0});return f}function bc(a,b){b.src?d.ajax({url:b.src,async:!1,dataType:"script"}):d.globalEval(b.text||b.textContent||b.innerHTML||""),b.parentNode&&b.parentNode.removeChild(b)}function bb(a){return"getElementsByTagName"in a?a.getElementsByTagName("*"):"querySelectorAll"in a?a.querySelectorAll("*"):[]}function ba(a,b){if(b.nodeType===1){var c=b.nodeName.toLowerCase();b.clearAttributes(),b.mergeAttributes(a);if(c==="object")b.outerHTML=a.outerHTML;else if(c!=="input"||a.type!=="checkbox"&&a.type!=="radio"){if(c==="option")b.selected=a.defaultSelected;else if(c==="input"||c==="textarea")b.defaultValue=a.defaultValue}else a.checked&&(b.defaultChecked=b.checked=a.checked),b.value!==a.value&&(b.value=a.value);b.removeAttribute(d.expando)}}function _(a,b){if(b.nodeType===1&&d.hasData(a)){var c=d.expando,e=d.data(a),f=d.data(b,e);if(e=e[c]){var g=e.events;f=f[c]=d.extend({},e);if(g){delete f.handle,f.events={};for(var h in g)for(var i=0,j=g[h].length;i<j;i++)d.event.add(b,h+(g[h][i].namespace?".":"")+g[h][i].namespace,g[h][i],g[h][i].data)}}}}function $(a,b){return d.nodeName(a,"table")?a.getElementsByTagName("tbody")[0]||a.appendChild(a.ownerDocument.createElement("tbody")):a}function Q(a,b,c){if(d.isFunction(b))return d.grep(a,function(a,d){var e=!!b.call(a,d,a);return e===c});if(b.nodeType)return d.grep(a,function(a,d){return a===b===c});if(typeof b==="string"){var e=d.grep(a,function(a){return a.nodeType===1});if(L.test(b))return d.filter(b,e,!c);b=d.filter(b,e)}return d.grep(a,function(a,e){return d.inArray(a,b)>=0===c})}function P(a){return!a||!a.parentNode||a.parentNode.nodeType===11}function H(a,b){return(a&&a!=="*"?a+".":"")+b.replace(t,"`").replace(u,"&")}function G(a){var b,c,e,f,g,h,i,j,k,l,m,n,o,p=[],q=[],s=d._data(this,"events");if(a.liveFired!==this&&s&&s.live&&!a.target.disabled&&(!a.button||a.type!=="click")){a.namespace&&(n=new RegExp("(^|\\.)"+a.namespace.split(".").join("\\.(?:.*\\.)?")+"(\\.|$)")),a.liveFired=this;var t=s.live.slice(0);for(i=0;i<t.length;i++)g=t[i],g.origType.replace(r,"")===a.type?q.push(g.selector):t.splice(i--,1);f=d(a.target).closest(q,a.currentTarget);for(j=0,k=f.length;j<k;j++){m=f[j];for(i=0;i<t.length;i++){g=t[i];if(m.selector===g.selector&&(!n||n.test(g.namespace))&&!m.elem.disabled){h=m.elem,e=null;if(g.preType==="mouseenter"||g.preType==="mouseleave")a.type=g.preType,e=d(a.relatedTarget).closest(g.selector)[0];(!e||e!==h)&&p.push({elem:h,handleObj:g,level:m.level})}}}for(j=0,k=p.length;j<k;j++){f=p[j];if(c&&f.level>c)break;a.currentTarget=f.elem,a.data=f.handleObj.data,a.handleObj=f.handleObj,o=f.handleObj.origHandler.apply(f.elem,arguments);if(o===!1||a.isPropagationStopped()){c=f.level,o===!1&&(b=!1);if(a.isImmediatePropagationStopped())break}}return b}}function E(a,c,e){var f=d.extend({},e[0]);f.type=a,f.originalEvent={},f.liveFired=b,d.event.handle.call(c,f),f.isDefaultPrevented()&&e[0].preventDefault()}function y(){return!0}function x(){return!1}function i(a){for(var b in a)if(b!=="toJSON")return!1;return!0}function h(a,c,e){if(e===b&&a.nodeType===1){e=a.getAttribute("data-"+c);if(typeof e==="string"){try{e=e==="true"?!0:e==="false"?!1:e==="null"?null:d.isNaN(e)?g.test(e)?d.parseJSON(e):e:parseFloat(e)}catch(f){}d.data(a,c,e)}else e=b}return e}var c=a.document,d=function(){function G(){if(!d.isReady){try{c.documentElement.doScroll("left")}catch(a){setTimeout(G,1);return}d.ready()}}var d=function(a,b){return new d.fn.init(a,b,g)},e=a.jQuery,f=a.$,g,h=/^(?:[^<]*(<[\w\W]+>)[^>]*$|#([\w\-]+)$)/,i=/\S/,j=/^\s+/,k=/\s+$/,l=/\d/,m=/^<(\w+)\s*\/?>(?:<\/\1>)?$/,n=/^[\],:{}\s]*$/,o=/\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g,p=/"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g,q=/(?:^|:|,)(?:\s*\[)+/g,r=/(webkit)[ \/]([\w.]+)/,s=/(opera)(?:.*version)?[ \/]([\w.]+)/,t=/(msie) ([\w.]+)/,u=/(mozilla)(?:.*? rv:([\w.]+))?/,v=navigator.userAgent,w,x,y,z=Object.prototype.toString,A=Object.prototype.hasOwnProperty,B=Array.prototype.push,C=Array.prototype.slice,D=String.prototype.trim,E=Array.prototype.indexOf,F={};d.fn=d.prototype={constructor:d,init:function(a,e,f){var g,i,j,k;if(!a)return this;if(a.nodeType){this.context=this[0]=a,this.length=1;return this}if(a==="body"&&!e&&c.body){this.context=c,this[0]=c.body,this.selector="body",this.length=1;return this}if(typeof a==="string"){g=h.exec(a);if(!g||!g[1]&&e)return!e||e.jquery?(e||f).find(a):this.constructor(e).find(a);if(g[1]){e=e instanceof d?e[0]:e,k=e?e.ownerDocument||e:c,j=m.exec(a),j?d.isPlainObject(e)?(a=[c.createElement(j[1])],d.fn.attr.call(a,e,!0)):a=[k.createElement(j[1])]:(j=d.buildFragment([g[1]],[k]),a=(j.cacheable?d.clone(j.fragment):j.fragment).childNodes);return d.merge(this,a)}i=c.getElementById(g[2]);if(i&&i.parentNode){if(i.id!==g[2])return f.find(a);this.length=1,this[0]=i}this.context=c,this.selector=a;return this}if(d.isFunction(a))return f.ready(a);a.selector!==b&&(this.selector=a.selector,this.context=a.context);return d.makeArray(a,this)},selector:"",jquery:"1.5.2",length:0,size:function(){return this.length},toArray:function(){return C.call(this,0)},get:function(a){return a==null?this.toArray():a<0?this[this.length+a]:this[a]},pushStack:function(a,b,c){var e=this.constructor();d.isArray(a)?B.apply(e,a):d.merge(e,a),e.prevObject=this,e.context=this.context,b==="find"?e.selector=this.selector+(this.selector?" ":"")+c:b&&(e.selector=this.selector+"."+b+"("+c+")");return e},each:function(a,b){return d.each(this,a,b)},ready:function(a){d.bindReady(),x.done(a);return this},eq:function(a){return a===-1?this.slice(a):this.slice(a,+a+1)},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},slice:function(){return this.pushStack(C.apply(this,arguments),"slice",C.call(arguments).join(","))},map:function(a){return this.pushStack(d.map(this,function(b,c){return a.call(b,c,b)}))},end:function(){return this.prevObject||this.constructor(null)},push:B,sort:[].sort,splice:[].splice},d.fn.init.prototype=d.fn,d.extend=d.fn.extend=function(){var a,c,e,f,g,h,i=arguments[0]||{},j=1,k=arguments.length,l=!1;typeof i==="boolean"&&(l=i,i=arguments[1]||{},j=2),typeof i!=="object"&&!d.isFunction(i)&&(i={}),k===j&&(i=this,--j);for(;j<k;j++)if((a=arguments[j])!=null)for(c in a){e=i[c],f=a[c];if(i===f)continue;l&&f&&(d.isPlainObject(f)||(g=d.isArray(f)))?(g?(g=!1,h=e&&d.isArray(e)?e:[]):h=e&&d.isPlainObject(e)?e:{},i[c]=d.extend(l,h,f)):f!==b&&(i[c]=f)}return i},d.extend({noConflict:function(b){a.$=f,b&&(a.jQuery=e);return d},isReady:!1,readyWait:1,ready:function(a){a===!0&&d.readyWait--;if(!d.readyWait||a!==!0&&!d.isReady){if(!c.body)return setTimeout(d.ready,1);d.isReady=!0;if(a!==!0&&--d.readyWait>0)return;x.resolveWith(c,[d]),d.fn.trigger&&d(c).trigger("ready").unbind("ready")}},bindReady:function(){if(!x){x=d._Deferred();if(c.readyState==="complete")return setTimeout(d.ready,1);if(c.addEventListener)c.addEventListener("DOMContentLoaded",y,!1),a.addEventListener("load",d.ready,!1);else if(c.attachEvent){c.attachEvent("onreadystatechange",y),a.attachEvent("onload",d.ready);var b=!1;try{b=a.frameElement==null}catch(e){}c.documentElement.doScroll&&b&&G()}}},isFunction:function(a){return d.type(a)==="function"},isArray:Array.isArray||function(a){return d.type(a)==="array"},isWindow:function(a){return a&&typeof a==="object"&&"setInterval"in a},isNaN:function(a){return a==null||!l.test(a)||isNaN(a)},type:function(a){return a==null?String(a):F[z.call(a)]||"object"},isPlainObject:function(a){if(!a||d.type(a)!=="object"||a.nodeType||d.isWindow(a))return!1;if(a.constructor&&!A.call(a,"constructor")&&!A.call(a.constructor.prototype,"isPrototypeOf"))return!1;var c;for(c in a){}return c===b||A.call(a,c)},isEmptyObject:function(a){for(var b in a)return!1;return!0},error:function(a){throw a},parseJSON:function(b){if(typeof b!=="string"||!b)return null;b=d.trim(b);if(n.test(b.replace(o,"@").replace(p,"]").replace(q,"")))return a.JSON&&a.JSON.parse?a.JSON.parse(b):(new Function("return "+b))();d.error("Invalid JSON: "+b)},parseXML:function(b,c,e){a.DOMParser?(e=new DOMParser,c=e.parseFromString(b,"text/xml")):(c=new ActiveXObject("Microsoft.XMLDOM"),c.async="false",c.loadXML(b)),e=c.documentElement,(!e||!e.nodeName||e.nodeName==="parsererror")&&d.error("Invalid XML: "+b);return c},noop:function(){},globalEval:function(a){if(a&&i.test(a)){var b=c.head||c.getElementsByTagName("head")[0]||c.documentElement,e=c.createElement("script");d.support.scriptEval()?e.appendChild(c.createTextNode(a)):e.text=a,b.insertBefore(e,b.firstChild),b.removeChild(e)}},nodeName:function(a,b){return a.nodeName&&a.nodeName.toUpperCase()===b.toUpperCase()},each:function(a,c,e){var f,g=0,h=a.length,i=h===b||d.isFunction(a);if(e){if(i){for(f in a)if(c.apply(a[f],e)===!1)break}else for(;g<h;)if(c.apply(a[g++],e)===!1)break}else if(i){for(f in a)if(c.call(a[f],f,a[f])===!1)break}else for(var j=a[0];g<h&&c.call(j,g,j)!==!1;j=a[++g]){}return a},trim:D?function(a){return a==null?"":D.call(a)}:function(a){return a==null?"":(a+"").replace(j,"").replace(k,"")},makeArray:function(a,b){var c=b||[];if(a!=null){var e=d.type(a);a.length==null||e==="string"||e==="function"||e==="regexp"||d.isWindow(a)?B.call(c,a):d.merge(c,a)}return c},inArray:function(a,b){if(b.indexOf)return b.indexOf(a);for(var c=0,d=b.length;c<d;c++)if(b[c]===a)return c;return-1},merge:function(a,c){var d=a.length,e=0;if(typeof c.length==="number")for(var f=c.length;e<f;e++)a[d++]=c[e];else while(c[e]!==b)a[d++]=c[e++];a.length=d;return a},grep:function(a,b,c){var d=[],e;c=!!c;for(var f=0,g=a.length;f<g;f++)e=!!b(a[f],f),c!==e&&d.push(a[f]);return d},map:function(a,b,c){var d=[],e;for(var f=0,g=a.length;f<g;f++)e=b(a[f],f,c),e!=null&&(d[d.length]=e);return d.concat.apply([],d)},guid:1,proxy:function(a,c,e){arguments.length===2&&(typeof c==="string"?(e=a,a=e[c],c=b):c&&!d.isFunction(c)&&(e=c,c=b)),!c&&a&&(c=function(){return a.apply(e||this,arguments)}),a&&(c.guid=a.guid=a.guid||c.guid||d.guid++);return c},access:function(a,c,e,f,g,h){var i=a.length;if(typeof c==="object"){for(var j in c)d.access(a,j,c[j],f,g,e);return a}if(e!==b){f=!h&&f&&d.isFunction(e);for(var k=0;k<i;k++)g(a[k],c,f?e.call(a[k],k,g(a[k],c)):e,h);return a}return i?g(a[0],c):b},now:function(){return(new Date).getTime()},uaMatch:function(a){a=a.toLowerCase();var b=r.exec(a)||s.exec(a)||t.exec(a)||a.indexOf("compatible")<0&&u.exec(a)||[];return{browser:b[1]||"",version:b[2]||"0"}},sub:function(){function a(b,c){return new a.fn.init(b,c)}d.extend(!0,a,this),a.superclass=this,a.fn=a.prototype=this(),a.fn.constructor=a,a.subclass=this.subclass,a.fn.init=function b(b,c){c&&c instanceof d&&!(c instanceof a)&&(c=a(c));return d.fn.init.call(this,b,c,e)},a.fn.init.prototype=a.fn;var e=a(c);return a},browser:{}}),d.each("Boolean Number String Function Array Date RegExp Object".split(" "),function(a,b){F["[object "+b+"]"]=b.toLowerCase()}),w=d.uaMatch(v),w.browser&&(d.browser[w.browser]=!0,d.browser.version=w.version),d.browser.webkit&&(d.browser.safari=!0),E&&(d.inArray=function(a,b){return E.call(b,a)}),i.test(" ")&&(j=/^[\s\xA0]+/,k=/[\s\xA0]+$/),g=d(c),c.addEventListener?y=function(){c.removeEventListener("DOMContentLoaded",y,!1),d.ready()}:c.attachEvent&&(y=function(){c.readyState==="complete"&&(c.detachEvent("onreadystatechange",y),d.ready())});return d}(),e="then done fail isResolved isRejected promise".split(" "),f=[].slice;d.extend({_Deferred:function(){var a=[],b,c,e,f={done:function(){if(!e){var c=arguments,g,h,i,j,k;b&&(k=b,b=0);for(g=0,h=c.length;g<h;g++)i=c[g],j=d.type(i),j==="array"?f.done.apply(f,i):j==="function"&&a.push(i);k&&f.resolveWith(k[0],k[1])}return this},resolveWith:function(d,f){if(!e&&!b&&!c){f=f||[],c=1;try{while(a[0])a.shift().apply(d,f)}finally{b=[d,f],c=0}}return this},resolve:function(){f.resolveWith(this,arguments);return this},isResolved:function(){return c||b},cancel:function(){e=1,a=[];return this}};return f},Deferred:function(a){var b=d._Deferred(),c=d._Deferred(),f;d.extend(b,{then:function(a,c){b.done(a).fail(c);return this},fail:c.done,rejectWith:c.resolveWith,reject:c.resolve,isRejected:c.isResolved,promise:function(a){if(a==null){if(f)return f;f=a={}}var c=e.length;while(c--)a[e[c]]=b[e[c]];return a}}),b.done(c.cancel).fail(b.cancel),delete b.cancel,a&&a.call(b,b);return b},when:function(a){function i(a){return function(c){b[a]=arguments.length>1?f.call(arguments,0):c,--g||h.resolveWith(h,f.call(b,0))}}var b=arguments,c=0,e=b.length,g=e,h=e<=1&&a&&d.isFunction(a.promise)?a:d.Deferred();if(e>1){for(;c<e;c++)b[c]&&d.isFunction(b[c].promise)?b[c].promise().then(i(c),h.reject):--g;g||h.resolveWith(h,b)}else h!==a&&h.resolveWith(h,e?[a]:[]);return h.promise()}}),function(){d.support={};var b=c.createElement("div");b.style.display="none",b.innerHTML=" <link/><table></table><a href='/a' style='color:red;float:left;opacity:.55;'>a</a><input type='checkbox'/>";var e=b.getElementsByTagName("*"),f=b.getElementsByTagName("a")[0],g=c.createElement("select"),h=g.appendChild(c.createElement("option")),i=b.getElementsByTagName("input")[0];if(e&&e.length&&f){d.support={leadingWhitespace:b.firstChild.nodeType===3,tbody:!b.getElementsByTagName("tbody").length,htmlSerialize:!!b.getElementsByTagName("link").length,style:/red/.test(f.getAttribute("style")),hrefNormalized:f.getAttribute("href")==="/a",opacity:/^0.55$/.test(f.style.opacity),cssFloat:!!f.style.cssFloat,checkOn:i.value==="on",optSelected:h.selected,deleteExpando:!0,optDisabled:!1,checkClone:!1,noCloneEvent:!0,noCloneChecked:!0,boxModel:null,inlineBlockNeedsLayout:!1,shrinkWrapBlocks:!1,reliableHiddenOffsets:!0,reliableMarginRight:!0},i.checked=!0,d.support.noCloneChecked=i.cloneNode(!0).checked,g.disabled=!0,d.support.optDisabled=!h.disabled;var j=null;d.support.scriptEval=function(){if(j===null){var b=c.documentElement,e=c.createElement("script"),f="script"+d.now();try{e.appendChild(c.createTextNode("window."+f+"=1;"))}catch(g){}b.insertBefore(e,b.firstChild),a[f]?(j=!0,delete a[f]):j=!1,b.removeChild(e)}return j};try{delete b.test}catch(k){d.support.deleteExpando=!1}!b.addEventListener&&b.attachEvent&&b.fireEvent&&(b.attachEvent("onclick",function l(){d.support.noCloneEvent=!1,b.detachEvent("onclick",l)}),b.cloneNode(!0).fireEvent("onclick")),b=c.createElement("div"),b.innerHTML="<input type='radio' name='radiotest' checked='checked'/>";var m=c.createDocumentFragment();m.appendChild(b.firstChild),d.support.checkClone=m.cloneNode(!0).cloneNode(!0).lastChild.checked,d(function(){var a=c.createElement("div"),b=c.getElementsByTagName("body")[0];if(b){a.style.width=a.style.paddingLeft="1px",b.appendChild(a),d.boxModel=d.support.boxModel=a.offsetWidth===2,"zoom"in a.style&&(a.style.display="inline",a.style.zoom=1,d.support.inlineBlockNeedsLayout=a.offsetWidth===2,a.style.display="",a.innerHTML="<div style='width:4px;'></div>",d.support.shrinkWrapBlocks=a.offsetWidth!==2),a.innerHTML="<table><tr><td style='padding:0;border:0;display:none'></td><td>t</td></tr></table>";var e=a.getElementsByTagName("td");d.support.reliableHiddenOffsets=e[0].offsetHeight===0,e[0].style.display="",e[1].style.display="none",d.support.reliableHiddenOffsets=d.support.reliableHiddenOffsets&&e[0].offsetHeight===0,a.innerHTML="",c.defaultView&&c.defaultView.getComputedStyle&&(a.style.width="1px",a.style.marginRight="0",d.support.reliableMarginRight=(parseInt(c.defaultView.getComputedStyle(a,null).marginRight,10)||0)===0),b.removeChild(a).style.display="none",a=e=null}});var n=function(a){var b=c.createElement("div");a="on"+a;if(!b.attachEvent)return!0;var d=a in b;d||(b.setAttribute(a,"return;"),d=typeof b[a]==="function");return d};d.support.submitBubbles=n("submit"),d.support.changeBubbles=n("change"),b=e=f=null}}();var g=/^(?:\{.*\}|\[.*\])$/;d.extend({cache:{},uuid:0,expando:"jQuery"+(d.fn.jquery+Math.random()).replace(/\D/g,""),noData:{embed:!0,object:"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000",applet:!0},hasData:function(a){a=a.nodeType?d.cache[a[d.expando]]:a[d.expando];return!!a&&!i(a)},data:function(a,c,e,f){if(d.acceptData(a)){var g=d.expando,h=typeof c==="string",i,j=a.nodeType,k=j?d.cache:a,l=j?a[d.expando]:a[d.expando]&&d.expando;if((!l||f&&l&&!k[l][g])&&h&&e===b)return;l||(j?a[d.expando]=l=++d.uuid:l=d.expando),k[l]||(k[l]={},j||(k[l].toJSON=d.noop));if(typeof c==="object"||typeof c==="function")f?k[l][g]=d.extend(k[l][g],c):k[l]=d.extend(k[l],c);i=k[l],f&&(i[g]||(i[g]={}),i=i[g]),e!==b&&(i[c]=e);if(c==="events"&&!i[c])return i[g]&&i[g].events;return h?i[c]:i}},removeData:function(b,c,e){if(d.acceptData(b)){var f=d.expando,g=b.nodeType,h=g?d.cache:b,j=g?b[d.expando]:d.expando;if(!h[j])return;if(c){var k=e?h[j][f]:h[j];if(k){delete k[c];if(!i(k))return}}if(e){delete h[j][f];if(!i(h[j]))return}var l=h[j][f];d.support.deleteExpando||h!=a?delete h[j]:h[j]=null,l?(h[j]={},g||(h[j].toJSON=d.noop),h[j][f]=l):g&&(d.support.deleteExpando?delete b[d.expando]:b.removeAttribute?b.removeAttribute(d.expando):b[d.expando]=null)}},_data:function(a,b,c){return d.data(a,b,c,!0)},acceptData:function(a){if(a.nodeName){var b=d.noData[a.nodeName.toLowerCase()];if(b)return b!==!0&&a.getAttribute("classid")===b}return!0}}),d.fn.extend({data:function(a,c){var e=null;if(typeof a==="undefined"){if(this.length){e=d.data(this[0]);if(this[0].nodeType===1){var f=this[0].attributes,g;for(var i=0,j=f.length;i<j;i++)g=f[i].name,g.indexOf("data-")===0&&(g=g.substr(5),h(this[0],g,e[g]))}}return e}if(typeof a==="object")return this.each(function(){d.data(this,a)});var k=a.split(".");k[1]=k[1]?"."+k[1]:"";if(c===b){e=this.triggerHandler("getData"+k[1]+"!",[k[0]]),e===b&&this.length&&(e=d.data(this[0],a),e=h(this[0],a,e));return e===b&&k[1]?this.data(k[0]):e}return this.each(function(){var b=d(this),e=[k[0],c];b.triggerHandler("setData"+k[1]+"!",e),d.data(this,a,c),b.triggerHandler("changeData"+k[1]+"!",e)})},removeData:function(a){return this.each(function(){d.removeData(this,a)})}}),d.extend({queue:function(a,b,c){if(a){b=(b||"fx")+"queue";var e=d._data(a,b);if(!c)return e||[];!e||d.isArray(c)?e=d._data(a,b,d.makeArray(c)):e.push(c);return e}},dequeue:function(a,b){b=b||"fx";var c=d.queue(a,b),e=c.shift();e==="inprogress"&&(e=c.shift()),e&&(b==="fx"&&c.unshift("inprogress"),e.call(a,function(){d.dequeue(a,b)})),c.length||d.removeData(a,b+"queue",!0)}}),d.fn.extend({queue:function(a,c){typeof a!=="string"&&(c=a,a="fx");if(c===b)return d.queue(this[0],a);return this.each(function(b){var e=d.queue(this,a,c);a==="fx"&&e[0]!=="inprogress"&&d.dequeue(this,a)})},dequeue:function(a){return this.each(function(){d.dequeue(this,a)})},delay:function(a,b){a=d.fx?d.fx.speeds[a]||a:a,b=b||"fx";return this.queue(b,function(){var c=this;setTimeout(function(){d.dequeue(c,b)},a)})},clearQueue:function(a){return this.queue(a||"fx",[])}});var j=/[\n\t\r]/g,k=/\s+/,l=/\r/g,m=/^(?:href|src|style)$/,n=/^(?:button|input)$/i,o=/^(?:button|input|object|select|textarea)$/i,p=/^a(?:rea)?$/i,q=/^(?:radio|checkbox)$/i;d.props={"for":"htmlFor","class":"className",readonly:"readOnly",maxlength:"maxLength",cellspacing:"cellSpacing",rowspan:"rowSpan",colspan:"colSpan",tabindex:"tabIndex",usemap:"useMap",frameborder:"frameBorder"},d.fn.extend({attr:function(a,b){return d.access(this,a,b,!0,d.attr)},removeAttr:function(a,b){return this.each(function(){d.attr(this,a,""),this.nodeType===1&&this.removeAttribute(a)})},addClass:function(a){if(d.isFunction(a))return this.each(function(b){var c=d(this);c.addClass(a.call(this,b,c.attr("class")))});if(a&&typeof a==="string"){var b=(a||"").split(k);for(var c=0,e=this.length;c<e;c++){var f=this[c];if(f.nodeType===1)if(f.className){var g=" "+f.className+" ",h=f.className;for(var i=0,j=b.length;i<j;i++)g.indexOf(" "+b[i]+" ")<0&&(h+=" "+b[i]);f.className=d.trim(h)}else f.className=a}}return this},removeClass:function(a){if(d.isFunction(a))return this.each(function(b){var c=d(this);c.removeClass(a.call(this,b,c.attr("class")))});if(a&&typeof a==="string"||a===b){var c=(a||"").split(k);for(var e=0,f=this.length;e<f;e++){var g=this[e];if(g.nodeType===1&&g.className)if(a){var h=(" "+g.className+" ").replace(j," ");for(var i=0,l=c.length;i<l;i++)h=h.replace(" "+c[i]+" "," ");g.className=d.trim(h)}else g.className=""}}return this},toggleClass:function(a,b){var c=typeof a,e=typeof b==="boolean";if(d.isFunction(a))return this.each(function(c){var e=d(this);e.toggleClass(a.call(this,c,e.attr("class"),b),b)});return this.each(function(){if(c==="string"){var f,g=0,h=d(this),i=b,j=a.split(k);while(f=j[g++])i=e?i:!h.hasClass(f),h[i?"addClass":"removeClass"](f)}else if(c==="undefined"||c==="boolean")this.className&&d._data(this,"__className__",this.className),this.className=this.className||a===!1?"":d._data(this,"__className__")||""})},hasClass:function(a){var b=" "+a+" ";for(var c=0,d=this.length;c<d;c++)if((" "+this[c].className+" ").replace(j," ").indexOf(b)>-1)return!0;return!1},val:function(a){if(!arguments.length){var c=this[0];if(c){if(d.nodeName(c,"option")){var e=c.attributes.value;return!e||e.specified?c.value:c.text}if(d.nodeName(c,"select")){var f=c.selectedIndex,g=[],h=c.options,i=c.type==="select-one";if(f<0)return null;for(var j=i?f:0,k=i?f+1:h.length;j<k;j++){var m=h[j];if(m.selected&&(d.support.optDisabled?!m.disabled:m.getAttribute("disabled")===null)&&(!m.parentNode.disabled||!d.nodeName(m.parentNode,"optgroup"))){a=d(m).val();if(i)return a;g.push(a)}}if(i&&!g.length&&h.length)return d(h[f]).val();return g}if(q.test(c.type)&&!d.support.checkOn)return c.getAttribute("value")===null?"on":c.value;return(c.value||"").replace(l,"")}return b}var n=d.isFunction(a);return this.each(function(b){var c=d(this),e=a;if(this.nodeType===1){n&&(e=a.call(this,b,c.val())),e==null?e="":typeof e==="number"?e+="":d.isArray(e)&&(e=d.map(e,function(a){return a==null?"":a+""}));if(d.isArray(e)&&q.test(this.type))this.checked=d.inArray(c.val(),e)>=0;else if(d.nodeName(this,"select")){var f=d.makeArray(e);d("option",this).each(function(){this.selected=d.inArray(d(this).val(),f)>=0}),f.length||(this.selectedIndex=-1)}else this.value=e}})}}),d.extend({attrFn:{val:!0,css:!0,html:!0,text:!0,data:!0,width:!0,height:!0,offset:!0},attr:function(a,c,e,f){if(!a||a.nodeType===3||a.nodeType===8||a.nodeType===2)return b;if(f&&c in d.attrFn)return d(a)[c](e);var g=a.nodeType!==1||!d.isXMLDoc(a),h=e!==b;c=g&&d.props[c]||c;if(a.nodeType===1){var i=m.test(c);if(c==="selected"&&!d.support.optSelected){var j=a.parentNode;j&&(j.selectedIndex,j.parentNode&&j.parentNode.selectedIndex)}if((c in a||a[c]!==b)&&g&&!i){h&&(c==="type"&&n.test(a.nodeName)&&a.parentNode&&d.error("type property can't be changed"),e===null?a.nodeType===1&&a.removeAttribute(c):a[c]=e);if(d.nodeName(a,"form")&&a.getAttributeNode(c))return a.getAttributeNode(c).nodeValue;if(c==="tabIndex"){var k=a.getAttributeNode("tabIndex");return k&&k.specified?k.value:o.test(a.nodeName)||p.test(a.nodeName)&&a.href?0:b}return a[c]}if(!d.support.style&&g&&c==="style"){h&&(a.style.cssText=""+e);return a.style.cssText}h&&a.setAttribute(c,""+e);if(!a.attributes[c]&&(a.hasAttribute&&!a.hasAttribute(c)))return b;var l=!d.support.hrefNormalized&&g&&i?a.getAttribute(c,2):a.getAttribute(c);return l===null?b:l}h&&(a[c]=e);return a[c]}});var r=/\.(.*)$/,s=/^(?:textarea|input|select)$/i,t=/\./g,u=/ /g,v=/[^\w\s.|`]/g,w=function(a){return a.replace(v,"\\$&")};d.event={add:function(c,e,f,g){if(c.nodeType!==3&&c.nodeType!==8){try{d.isWindow(c)&&(c!==a&&!c.frameElement)&&(c=a)}catch(h){}if(f===!1)f=x;else if(!f)return;var i,j;f.handler&&(i=f,f=i.handler),f.guid||(f.guid=d.guid++);var k=d._data(c);if(!k)return;var l=k.events,m=k.handle;l||(k.events=l={}),m||(k.handle=m=function(a){return typeof d!=="undefined"&&d.event.triggered!==a.type?d.event.handle.apply(m.elem,arguments):b}),m.elem=c,e=e.split(" ");var n,o=0,p;while(n=e[o++]){j=i?d.extend({},i):{handler:f,data:g},n.indexOf(".")>-1?(p=n.split("."),n=p.shift(),j.namespace=p.slice(0).sort().join(".")):(p=[],j.namespace=""),j.type=n,j.guid||(j.guid=f.guid);var q=l[n],r=d.event.special[n]||{};if(!q){q=l[n]=[];if(!r.setup||r.setup.call(c,g,p,m)===!1)c.addEventListener?c.addEventListener(n,m,!1):c.attachEvent&&c.attachEvent("on"+n,m)}r.add&&(r.add.call(c,j),j.handler.guid||(j.handler.guid=f.guid)),q.push(j),d.event.global[n]=!0}c=null}},global:{},remove:function(a,c,e,f){if(a.nodeType!==3&&a.nodeType!==8){e===!1&&(e=x);var g,h,i,j,k=0,l,m,n,o,p,q,r,s=d.hasData(a)&&d._data(a),t=s&&s.events;if(!s||!t)return;c&&c.type&&(e=c.handler,c=c.type);if(!c||typeof c==="string"&&c.charAt(0)==="."){c=c||"";for(h in t)d.event.remove(a,h+c);return}c=c.split(" ");while(h=c[k++]){r=h,q=null,l=h.indexOf(".")<0,m=[],l||(m=h.split("."),h=m.shift(),n=new RegExp("(^|\\.)"+d.map(m.slice(0).sort(),w).join("\\.(?:.*\\.)?")+"(\\.|$)")),p=t[h];if(!p)continue;if(!e){for(j=0;j<p.length;j++){q=p[j];if(l||n.test(q.namespace))d.event.remove(a,r,q.handler,j),p.splice(j--,1)}continue}o=d.event.special[h]||{};for(j=f||0;j<p.length;j++){q=p[j];if(e.guid===q.guid){if(l||n.test(q.namespace))f==null&&p.splice(j--,1),o.remove&&o.remove.call(a,q);if(f!=null)break}}if(p.length===0||f!=null&&p.length===1)(!o.teardown||o.teardown.call(a,m)===!1)&&d.removeEvent(a,h,s.handle),g=null,delete t[h]}if(d.isEmptyObject(t)){var u=s.handle;u&&(u.elem=null),delete s.events,delete s.handle,d.isEmptyObject(s)&&d.removeData(a,b,!0)}}},trigger:function(a,c,e){var f=a.type||a,g=arguments[3];if(!g){a=typeof a==="object"?a[d.expando]?a:d.extend(d.Event(f),a):d.Event(f),f.indexOf("!")>=0&&(a.type=f=f.slice(0,-1),a.exclusive=!0),e||(a.stopPropagation(),d.event.global[f]&&d.each(d.cache,function(){var b=d.expando,e=this[b];e&&e.events&&e.events[f]&&d.event.trigger(a,c,e.handle.elem)}));if(!e||e.nodeType===3||e.nodeType===8)return b;a.result=b,a.target=e,c=d.makeArray(c),c.unshift(a)}a.currentTarget=e;var h=d._data(e,"handle");h&&h.apply(e,c);var i=e.parentNode||e.ownerDocument;try{e&&e.nodeName&&d.noData[e.nodeName.toLowerCase()]||e["on"+f]&&e["on"+f].apply(e,c)===!1&&(a.result=!1,a.preventDefault())}catch(j){}if(!a.isPropagationStopped()&&i)d.event.trigger(a,c,i,!0);else if(!a.isDefaultPrevented()){var k,l=a.target,m=f.replace(r,""),n=d.nodeName(l,"a")&&m==="click",o=d.event.special[m]||{};if((!o._default||o._default.call(e,a)===!1)&&!n&&!(l&&l.nodeName&&d.noData[l.nodeName.toLowerCase()])){try{l[m]&&(k=l["on"+m],k&&(l["on"+m]=null),d.event.triggered=a.type,l[m]())}catch(p){}k&&(l["on"+m]=k),d.event.triggered=b}}},handle:function(c){var e,f,g,h,i,j=[],k=d.makeArray(arguments);c=k[0]=d.event.fix(c||a.event),c.currentTarget=this,e=c.type.indexOf(".")<0&&!c.exclusive,e||(g=c.type.split("."),c.type=g.shift(),j=g.slice(0).sort(),h=new RegExp("(^|\\.)"+j.join("\\.(?:.*\\.)?")+"(\\.|$)")),c.namespace=c.namespace||j.join("."),i=d._data(this,"events"),f=(i||{})[c.type];if(i&&f){f=f.slice(0);for(var l=0,m=f.length;l<m;l++){var n=f[l];if(e||h.test(n.namespace)){c.handler=n.handler,c.data=n.data,c.handleObj=n;var o=n.handler.apply(this,k);o!==b&&(c.result=o,o===!1&&(c.preventDefault(),c.stopPropagation()));if(c.isImmediatePropagationStopped())break}}}return c.result},props:"altKey attrChange attrName bubbles button cancelable charCode clientX clientY ctrlKey currentTarget data detail eventPhase fromElement handler keyCode layerX layerY metaKey newValue offsetX offsetY pageX pageY prevValue relatedNode relatedTarget screenX screenY shiftKey srcElement target toElement view wheelDelta which".split(" "),fix:function(a){if(a[d.expando])return a;var e=a;a=d.Event(e);for(var f=this.props.length,g;f;)g=this.props[--f],a[g]=e[g];a.target||(a.target=a.srcElement||c),a.target.nodeType===3&&(a.target=a.target.parentNode),!a.relatedTarget&&a.fromElement&&(a.relatedTarget=a.fromElement===a.target?a.toElement:a.fromElement);if(a.pageX==null&&a.clientX!=null){var h=c.documentElement,i=c.body;a.pageX=a.clientX+(h&&h.scrollLeft||i&&i.scrollLeft||0)-(h&&h.clientLeft||i&&i.clientLeft||0),a.pageY=a.clientY+(h&&h.scrollTop||i&&i.scrollTop||0)-(h&&h.clientTop||i&&i.clientTop||0)}a.which==null&&(a.charCode!=null||a.keyCode!=null)&&(a.which=a.charCode!=null?a.charCode:a.keyCode),!a.metaKey&&a.ctrlKey&&(a.metaKey=a.ctrlKey),!a.which&&a.button!==b&&(a.which=a.button&1?1:a.button&2?3:a.button&4?2:0);return a},guid:1e8,proxy:d.proxy,special:{ready:{setup:d.bindReady,teardown:d.noop},live:{add:function(a){d.event.add(this,H(a.origType,a.selector),d.extend({},a,{handler:G,guid:a.handler.guid}))},remove:function(a){d.event.remove(this,H(a.origType,a.selector),a)}},beforeunload:{setup:function(a,b,c){d.isWindow(this)&&(this.onbeforeunload=c)},teardown:function(a,b){this.onbeforeunload===b&&(this.onbeforeunload=null)}}}},d.removeEvent=c.removeEventListener?function(a,b,c){a.removeEventListener&&a.removeEventListener(b,c,!1)}:function(a,b,c){a.detachEvent&&a.detachEvent("on"+b,c)},d.Event=function(a){if(!this.preventDefault)return new d.Event(a);a&&a.type?(this.originalEvent=a,this.type=a.type,this.isDefaultPrevented=a.defaultPrevented||a.returnValue===!1||a.getPreventDefault&&a.getPreventDefault()?y:x):this.type=a,this.timeStamp=d.now(),this[d.expando]=!0},d.Event.prototype={preventDefault:function(){this.isDefaultPrevented=y;var a=this.originalEvent;a&&(a.preventDefault?a.preventDefault():a.returnValue=!1)},stopPropagation:function(){this.isPropagationStopped=y;var a=this.originalEvent;a&&(a.stopPropagation&&a.stopPropagation(),a.cancelBubble=!0)},stopImmediatePropagation:function(){this.isImmediatePropagationStopped=y,this.stopPropagation()},isDefaultPrevented:x,isPropagationStopped:x,isImmediatePropagationStopped:x};var z=function(a){var b=a.relatedTarget;try{if(b&&b!==c&&!b.parentNode)return;while(b&&b!==this)b=b.parentNode;b!==this&&(a.type=a.data,d.event.handle.apply(this,arguments))}catch(e){}},A=function(a){a.type=a.data,d.event.handle.apply(this,arguments)};d.each({mouseenter:"mouseover",mouseleave:"mouseout"},function(a,b){d.event.special[a]={setup:function(c){d.event.add(this,b,c&&c.selector?A:z,a)},teardown:function(a){d.event.remove(this,b,a&&a.selector?A:z)}}}),d.support.submitBubbles||(d.event.special.submit={setup:function(a,b){if(this.nodeName&&this.nodeName.toLowerCase()!=="form")d.event.add(this,"click.specialSubmit",function(a){var b=a.target,c=b.type;(c==="submit"||c==="image")&&d(b).closest("form").length&&E("submit",this,arguments)}),d.event.add(this,"keypress.specialSubmit",function(a){var b=a.target,c=b.type;(c==="text"||c==="password")&&d(b).closest("form").length&&a.keyCode===13&&E("submit",this,arguments)});else return!1},teardown:function(a){d.event.remove(this,".specialSubmit")}});if(!d.support.changeBubbles){var B,C=function(a){var b=a.type,c=a.value;b==="radio"||b==="checkbox"?c=a.checked:b==="select-multiple"?c=a.selectedIndex>-1?d.map(a.options,function(a){return a.selected}).join("-"):"":a.nodeName.toLowerCase()==="select"&&(c=a.selectedIndex);return c},D=function D(a){var c=a.target,e,f;if(s.test(c.nodeName)&&!c.readOnly){e=d._data(c,"_change_data"),f=C(c),(a.type!=="focusout"||c.type!=="radio")&&d._data(c,"_change_data",f);if(e===b||f===e)return;if(e!=null||f)a.type="change",a.liveFired=b,d.event.trigger(a,arguments[1],c)}};d.event.special.change={filters:{focusout:D,beforedeactivate:D,click:function(a){var b=a.target,c=b.type;(c==="radio"||c==="checkbox"||b.nodeName.toLowerCase()==="select")&&D.call(this,a)},keydown:function(a){var b=a.target,c=b.type;(a.keyCode===13&&b.nodeName.toLowerCase()!=="textarea"||a.keyCode===32&&(c==="checkbox"||c==="radio")||c==="select-multiple")&&D.call(this,a)},beforeactivate:function(a){var b=a.target;d._data(b,"_change_data",C(b))}},setup:function(a,b){if(this.type==="file")return!1;for(var c in B)d.event.add(this,c+".specialChange",B[c]);return s.test(this.nodeName)},teardown:function(a){d.event.remove(this,".specialChange");return s.test(this.nodeName)}},B=d.event.special.change.filters,B.focus=B.beforeactivate}c.addEventListener&&d.each({focus:"focusin",blur:"focusout"},function(a,b){function f(a){var c=d.event.fix(a);c.type=b,c.originalEvent={},d.event.trigger(c,null,c.target),c.isDefaultPrevented()&&a.preventDefault()}var e=0;d.event.special[b]={setup:function(){e++===0&&c.addEventListener(a,f,!0)},teardown:function(){--e===0&&c.removeEventListener(a,f,!0)}}}),d.each(["bind","one"],function(a,c){d.fn[c]=function(a,e,f){if(typeof a==="object"){for(var g in a)this[c](g,e,a[g],f);return this}if(d.isFunction(e)||e===!1)f=e,e=b;var h=c==="one"?d.proxy(f,function(a){d(this).unbind(a,h);return f.apply(this,arguments)}):f;if(a==="unload"&&c!=="one")this.one(a,e,f);else for(var i=0,j=this.length;i<j;i++)d.event.add(this[i],a,h,e);return this}}),d.fn.extend({unbind:function(a,b){if(typeof a!=="object"||a.preventDefault)for(var e=0,f=this.length;e<f;e++)d.event.remove(this[e],a,b);else for(var c in a)this.unbind(c,a[c]);return this},delegate:function(a,b,c,d){return this.live(b,c,d,a)},undelegate:function(a,b,c){return arguments.length===0?this.unbind("live"):this.die(b,null,c,a)},trigger:function(a,b){return this.each(function(){d.event.trigger(a,b,this)})},triggerHandler:function(a,b){if(this[0]){var c=d.Event(a);c.preventDefault(),c.stopPropagation(),d.event.trigger(c,b,this[0]);return c.result}},toggle:function(a){var b=arguments,c=1;while(c<b.length)d.proxy(a,b[c++]);return this.click(d.proxy(a,function(e){var f=(d._data(this,"lastToggle"+a.guid)||0)%c;d._data(this,"lastToggle"+a.guid,f+1),e.preventDefault();return b[f].apply(this,arguments)||!1}))},hover:function(a,b){return this.mouseenter(a).mouseleave(b||a)}});var F={focus:"focusin",blur:"focusout",mouseenter:"mouseover",mouseleave:"mouseout"};d.each(["live","die"],function(a,c){d.fn[c]=function(a,e,f,g){var h,i=0,j,k,l,m=g||this.selector,n=g?this:d(this.context);if(typeof a==="object"&&!a.preventDefault){for(var o in a)n[c](o,e,a[o],m);return this}d.isFunction(e)&&(f=e,e=b),a=(a||"").split(" ");while((h=a[i++])!=null){j=r.exec(h),k="",j&&(k=j[0],h=h.replace(r,""));if(h==="hover"){a.push("mouseenter"+k,"mouseleave"+k);continue}l=h,h==="focus"||h==="blur"?(a.push(F[h]+k),h=h+k):h=(F[h]||h)+k;if(c==="live")for(var p=0,q=n.length;p<q;p++)d.event.add(n[p],"live."+H(h,m),{data:e,selector:m,handler:f,origType:h,origHandler:f,preType:l});else n.unbind("live."+H(h,m),f)}return this}}),d.each("blur focus focusin focusout load resize scroll unload click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup error".split(" "),function(a,b){d.fn[b]=function(a,c){c==null&&(c=a,a=null);return arguments.length>0?this.bind(b,a,c):this.trigger(b)},d.attrFn&&(d.attrFn[b]=!0)}),function(){function u(a,b,c,d,e,f){for(var g=0,h=d.length;g<h;g++){var i=d[g];if(i){var j=!1;i=i[a];while(i){if(i.sizcache===c){j=d[i.sizset];break}if(i.nodeType===1){f||(i.sizcache=c,i.sizset=g);if(typeof b!=="string"){if(i===b){j=!0;break}}else if(k.filter(b,[i]).length>0){j=i;break}}i=i[a]}d[g]=j}}}function t(a,b,c,d,e,f){for(var g=0,h=d.length;g<h;g++){var i=d[g];if(i){var j=!1;i=i[a];while(i){if(i.sizcache===c){j=d[i.sizset];break}i.nodeType===1&&!f&&(i.sizcache=c,i.sizset=g);if(i.nodeName.toLowerCase()===b){j=i;break}i=i[a]}d[g]=j}}}var a=/((?:\((?:\([^()]+\)|[^()]+)+\)|\[(?:\[[^\[\]]*\]|['"][^'"]*['"]|[^\[\]'"]+)+\]|\\.|[^ >+~,(\[\\]+)+|[>+~])(\s*,\s*)?((?:.|\r|\n)*)/g,e=0,f=Object.prototype.toString,g=!1,h=!0,i=/\\/g,j=/\W/;[0,0].sort(function(){h=!1;return 0});var k=function(b,d,e,g){e=e||[],d=d||c;var h=d;if(d.nodeType!==1&&d.nodeType!==9)return[];if(!b||typeof b!=="string")return e;var i,j,n,o,q,r,s,t,u=!0,w=k.isXML(d),x=[],y=b;do{a.exec(""),i=a.exec(y);if(i){y=i[3],x.push(i[1]);if(i[2]){o=i[3];break}}}while(i);if(x.length>1&&m.exec(b))if(x.length===2&&l.relative[x[0]])j=v(x[0]+x[1],d);else{j=l.relative[x[0]]?[d]:k(x.shift(),d);while(x.length)b=x.shift(),l.relative[b]&&(b+=x.shift()),j=v(b,j)}else{!g&&x.length>1&&d.nodeType===9&&!w&&l.match.ID.test(x[0])&&!l.match.ID.test(x[x.length-1])&&(q=k.find(x.shift(),d,w),d=q.expr?k.filter(q.expr,q.set)[0]:q.set[0]);if(d){q=g?{expr:x.pop(),set:p(g)}:k.find(x.pop(),x.length===1&&(x[0]==="~"||x[0]==="+")&&d.parentNode?d.parentNode:d,w),j=q.expr?k.filter(q.expr,q.set):q.set,x.length>0?n=p(j):u=!1;while(x.length)r=x.pop(),s=r,l.relative[r]?s=x.pop():r="",s==null&&(s=d),l.relative[r](n,s,w)}else n=x=[]}n||(n=j),n||k.error(r||b);if(f.call(n)==="[object Array]")if(u)if(d&&d.nodeType===1)for(t=0;n[t]!=null;t++)n[t]&&(n[t]===!0||n[t].nodeType===1&&k.contains(d,n[t]))&&e.push(j[t]);else for(t=0;n[t]!=null;t++)n[t]&&n[t].nodeType===1&&e.push(j[t]);else e.push.apply(e,n);else p(n,e);o&&(k(o,h,e,g),k.uniqueSort(e));return e};k.uniqueSort=function(a){if(r){g=h,a.sort(r);if(g)for(var b=1;b<a.length;b++)a[b]===a[b-1]&&a.splice(b--,1)}return a},k.matches=function(a,b){return k(a,null,null,b)},k.matchesSelector=function(a,b){return k(b,null,null,[a]).length>0},k.find=function(a,b,c){var d;if(!a)return[];for(var e=0,f=l.order.length;e<f;e++){var g,h=l.order[e];if(g=l.leftMatch[h].exec(a)){var j=g[1];g.splice(1,1);if(j.substr(j.length-1)!=="\\"){g[1]=(g[1]||"").replace(i,""),d=l.find[h](g,b,c);if(d!=null){a=a.replace(l.match[h],"");break}}}}d||(d=typeof b.getElementsByTagName!=="undefined"?b.getElementsByTagName("*"):[]);return{set:d,expr:a}},k.filter=function(a,c,d,e){var f,g,h=a,i=[],j=c,m=c&&c[0]&&k.isXML(c[0]);while(a&&c.length){for(var n in l.filter)if((f=l.leftMatch[n].exec(a))!=null&&f[2]){var o,p,q=l.filter[n],r=f[1];g=!1,f.splice(1,1);if(r.substr(r.length-1)==="\\")continue;j===i&&(i=[]);if(l.preFilter[n]){f=l.preFilter[n](f,j,d,i,e,m);if(f){if(f===!0)continue}else g=o=!0}if(f)for(var s=0;(p=j[s])!=null;s++)if(p){o=q(p,f,s,j);var t=e^!!o;d&&o!=null?t?g=!0:j[s]=!1:t&&(i.push(p),g=!0)}if(o!==b){d||(j=i),a=a.replace(l.match[n],"");if(!g)return[];break}}if(a===h)if(g==null)k.error(a);else break;h=a}return j},k.error=function(a){throw"Syntax error, unrecognized expression: "+a};var l=k.selectors={order:["ID","NAME","TAG"],match:{ID:/#((?:[\w\u00c0-\uFFFF\-]|\\.)+)/,CLASS:/\.((?:[\w\u00c0-\uFFFF\-]|\\.)+)/,NAME:/\[name=['"]*((?:[\w\u00c0-\uFFFF\-]|\\.)+)['"]*\]/,ATTR:/\[\s*((?:[\w\u00c0-\uFFFF\-]|\\.)+)\s*(?:(\S?=)\s*(?:(['"])(.*?)\3|(#?(?:[\w\u00c0-\uFFFF\-]|\\.)*)|)|)\s*\]/,TAG:/^((?:[\w\u00c0-\uFFFF\*\-]|\\.)+)/,CHILD:/:(only|nth|last|first)-child(?:\(\s*(even|odd|(?:[+\-]?\d+|(?:[+\-]?\d*)?n\s*(?:[+\-]\s*\d+)?))\s*\))?/,POS:/:(nth|eq|gt|lt|first|last|even|odd)(?:\((\d*)\))?(?=[^\-]|$)/,PSEUDO:/:((?:[\w\u00c0-\uFFFF\-]|\\.)+)(?:\((['"]?)((?:\([^\)]+\)|[^\(\)]*)+)\2\))?/},leftMatch:{},attrMap:{"class":"className","for":"htmlFor"},attrHandle:{href:function(a){return a.getAttribute("href")},type:function(a){return a.getAttribute("type")}},relative:{"+":function(a,b){var c=typeof b==="string",d=c&&!j.test(b),e=c&&!d;d&&(b=b.toLowerCase());for(var f=0,g=a.length,h;f<g;f++)if(h=a[f]){while((h=h.previousSibling)&&h.nodeType!==1){}a[f]=e||h&&h.nodeName.toLowerCase()===b?h||!1:h===b}e&&k.filter(b,a,!0)},">":function(a,b){var c,d=typeof b==="string",e=0,f=a.length;if(d&&!j.test(b)){b=b.toLowerCase();for(;e<f;e++){c=a[e];if(c){var g=c.parentNode;a[e]=g.nodeName.toLowerCase()===b?g:!1}}}else{for(;e<f;e++)c=a[e],c&&(a[e]=d?c.parentNode:c.parentNode===b);d&&k.filter(b,a,!0)}},"":function(a,b,c){var d,f=e++,g=u;typeof b==="string"&&!j.test(b)&&(b=b.toLowerCase(),d=b,g=t),g("parentNode",b,f,a,d,c)},"~":function(a,b,c){var d,f=e++,g=u;typeof b==="string"&&!j.test(b)&&(b=b.toLowerCase(),d=b,g=t),g("previousSibling",b,f,a,d,c)}},find:{ID:function(a,b,c){if(typeof b.getElementById!=="undefined"&&!c){var d=b.getElementById(a[1]);return d&&d.parentNode?[d]:[]}},NAME:function(a,b){if(typeof b.getElementsByName!=="undefined"){var c=[],d=b.getElementsByName(a[1]);for(var e=0,f=d.length;e<f;e++)d[e].getAttribute("name")===a[1]&&c.push(d[e]);return c.length===0?null:c}},TAG:function(a,b){if(typeof b.getElementsByTagName!=="undefined")return b.getElementsByTagName(a[1])}},preFilter:{CLASS:function(a,b,c,d,e,f){a=" "+a[1].replace(i,"")+" ";if(f)return a;for(var g=0,h;(h=b[g])!=null;g++)h&&(e^(h.className&&(" "+h.className+" ").replace(/[\t\n\r]/g," ").indexOf(a)>=0)?c||d.push(h):c&&(b[g]=!1));return!1},ID:function(a){return a[1].replace(i,"")},TAG:function(a,b){return a[1].replace(i,"").toLowerCase()},CHILD:function(a){if(a[1]==="nth"){a[2]||k.error(a[0]),a[2]=a[2].replace(/^\+|\s*/g,"");var b=/(-?)(\d*)(?:n([+\-]?\d*))?/.exec(a[2]==="even"&&"2n"||a[2]==="odd"&&"2n+1"||!/\D/.test(a[2])&&"0n+"+a[2]||a[2]);a[2]=b[1]+(b[2]||1)-0,a[3]=b[3]-0}else a[2]&&k.error(a[0]);a[0]=e++;return a},ATTR:function(a,b,c,d,e,f){var g=a[1]=a[1].replace(i,"");!f&&l.attrMap[g]&&(a[1]=l.attrMap[g]),a[4]=(a[4]||a[5]||"").replace(i,""),a[2]==="~="&&(a[4]=" "+a[4]+" ");return a},PSEUDO:function(b,c,d,e,f){if(b[1]==="not")if((a.exec(b[3])||"").length>1||/^\w/.test(b[3]))b[3]=k(b[3],null,null,c);else{var g=k.filter(b[3],c,d,!0^f);d||e.push.apply(e,g);return!1}else if(l.match.POS.test(b[0])||l.match.CHILD.test(b[0]))return!0;return b},POS:function(a){a.unshift(!0);return a}},filters:{enabled:function(a){return a.disabled===!1&&a.type!=="hidden"},disabled:function(a){return a.disabled===!0},checked:function(a){return a.checked===!0},selected:function(a){a.parentNode&&a.parentNode.selectedIndex;return a.selected===!0},parent:function(a){return!!a.firstChild},empty:function(a){return!a.firstChild},has:function(a,b,c){return!!k(c[3],a).length},header:function(a){return/h\d/i.test(a.nodeName)},text:function(a){var b=a.getAttribute("type"),c=a.type;return"text"===c&&(b===c||b===null)},radio:function(a){return"radio"===a.type},checkbox:function(a){return"checkbox"===a.type},file:function(a){return"file"===a.type},password:function(a){return"password"===a.type},submit:function(a){return"submit"===a.type},image:function(a){return"image"===a.type},reset:function(a){return"reset"===a.type},button:function(a){return"button"===a.type||a.nodeName.toLowerCase()==="button"},input:function(a){return/input|select|textarea|button/i.test(a.nodeName)}},setFilters:{first:function(a,b){return b===0},last:function(a,b,c,d){return b===d.length-1},even:function(a,b){return b%2===0},odd:function(a,b){return b%2===1},lt:function(a,b,c){return b<c[3]-0},gt:function(a,b,c){return b>c[3]-0},nth:function(a,b,c){return c[3]-0===b},eq:function(a,b,c){return c[3]-0===b}},filter:{PSEUDO:function(a,b,c,d){var e=b[1],f=l.filters[e];if(f)return f(a,c,b,d);if(e==="contains")return(a.textContent||a.innerText||k.getText([a])||"").indexOf(b[3])>=0;if(e==="not"){var g=b[3];for(var h=0,i=g.length;h<i;h++)if(g[h]===a)return!1;return!0}k.error(e)},CHILD:function(a,b){var c=b[1],d=a;switch(c){case"only":case"first":while(d=d.previousSibling)if(d.nodeType===1)return!1;if(c==="first")return!0;d=a;case"last":while(d=d.nextSibling)if(d.nodeType===1)return!1;return!0;case"nth":var e=b[2],f=b[3];if(e===1&&f===0)return!0;var g=b[0],h=a.parentNode;if(h&&(h.sizcache!==g||!a.nodeIndex)){var i=0;for(d=h.firstChild;d;d=d.nextSibling)d.nodeType===1&&(d.nodeIndex=++i);h.sizcache=g}var j=a.nodeIndex-f;return e===0?j===0:j%e===0&&j/e>=0}},ID:function(a,b){return a.nodeType===1&&a.getAttribute("id")===b},TAG:function(a,b){return b==="*"&&a.nodeType===1||a.nodeName.toLowerCase()===b},CLASS:function(a,b){return(" "+(a.className||a.getAttribute("class"))+" ").indexOf(b)>-1},ATTR:function(a,b){var c=b[1],d=l.attrHandle[c]?l.attrHandle[c](a):a[c]!=null?a[c]:a.getAttribute(c),e=d+"",f=b[2],g=b[4];return d==null?f==="!=":f==="="?e===g:f==="*="?e.indexOf(g)>=0:f==="~="?(" "+e+" ").indexOf(g)>=0:g?f==="!="?e!==g:f==="^="?e.indexOf(g)===0:f==="$="?e.substr(e.length-g.length)===g:f==="|="?e===g||e.substr(0,g.length+1)===g+"-":!1:e&&d!==!1},POS:function(a,b,c,d){var e=b[2],f=l.setFilters[e];if(f)return f(a,c,b,d)}}},m=l.match.POS,n=function(a,b){return"\\"+(b-0+1)};for(var o in l.match)l.match[o]=new RegExp(l.match[o].source+/(?![^\[]*\])(?![^\(]*\))/.source),l.leftMatch[o]=new RegExp(/(^(?:.|\r|\n)*?)/.source+l.match[o].source.replace(/\\(\d+)/g,n));var p=function(a,b){a=Array.prototype.slice.call(a,0);if(b){b.push.apply(b,a);return b}return a};try{Array.prototype.slice.call(c.documentElement.childNodes,0)[0].nodeType}catch(q){p=function(a,b){var c=0,d=b||[];if(f.call(a)==="[object Array]")Array.prototype.push.apply(d,a);else if(typeof a.length==="number")for(var e=a.length;c<e;c++)d.push(a[c]);else for(;a[c];c++)d.push(a[c]);return d}}var r,s;c.documentElement.compareDocumentPosition?r=function(a,b){if(a===b){g=!0;return 0}if(!a.compareDocumentPosition||!b.compareDocumentPosition)return a.compareDocumentPosition?-1:1;return a.compareDocumentPosition(b)&4?-1:1}:(r=function(a,b){var c,d,e=[],f=[],h=a.parentNode,i=b.parentNode,j=h;if(a===b){g=!0;return 0}if(h===i)return s(a,b);if(!h)return-1;if(!i)return 1;while(j)e.unshift(j),j=j.parentNode;j=i;while(j)f.unshift(j),j=j.parentNode;c=e.length,d=f.length;for(var k=0;k<c&&k<d;k++)if(e[k]!==f[k])return s(e[k],f[k]);return k===c?s(a,f[k],-1):s(e[k],b,1)},s=function(a,b,c){if(a===b)return c;var d=a.nextSibling;while(d){if(d===b)return-1;d=d.nextSibling}return 1}),k.getText=function(a){var b="",c;for(var d=0;a[d];d++)c=a[d],c.nodeType===3||c.nodeType===4?b+=c.nodeValue:c.nodeType!==8&&(b+=k.getText(c.childNodes));return b},function(){var a=c.createElement("div"),d="script"+(new Date).getTime(),e=c.documentElement;a.innerHTML="<a name='"+d+"'/>",e.insertBefore(a,e.firstChild),c.getElementById(d)&&(l.find.ID=function(a,c,d){if(typeof c.getElementById!=="undefined"&&!d){var e=c.getElementById(a[1]);return e?e.id===a[1]||typeof e.getAttributeNode!=="undefined"&&e.getAttributeNode("id").nodeValue===a[1]?[e]:b:[]}},l.filter.ID=function(a,b){var c=typeof a.getAttributeNode!=="undefined"&&a.getAttributeNode("id");return a.nodeType===1&&c&&c.nodeValue===b}),e.removeChild(a),e=a=null}(),function(){var a=c.createElement("div");a.appendChild(c.createComment("")),a.getElementsByTagName("*").length>0&&(l.find.TAG=function(a,b){var c=b.getElementsByTagName(a[1]);if(a[1]==="*"){var d=[];for(var e=0;c[e];e++)c[e].nodeType===1&&d.push(c[e]);c=d}return c}),a.innerHTML="<a href='#'></a>",a.firstChild&&typeof a.firstChild.getAttribute!=="undefined"&&a.firstChild.getAttribute("href")!=="#"&&(l.attrHandle.href=function(a){return a.getAttribute("href",2)}),a=null}(),c.querySelectorAll&&function(){var a=k,b=c.createElement("div"),d="__sizzle__";b.innerHTML="<p class='TEST'></p>";if(!b.querySelectorAll||b.querySelectorAll(".TEST").length!==0){k=function(b,e,f,g){e=e||c;if(!g&&!k.isXML(e)){var h=/^(\w+$)|^\.([\w\-]+$)|^#([\w\-]+$)/.exec(b);if(h&&(e.nodeType===1||e.nodeType===9)){if(h[1])return p(e.getElementsByTagName(b),f);if(h[2]&&l.find.CLASS&&e.getElementsByClassName)return p(e.getElementsByClassName(h[2]),f)}if(e.nodeType===9){if(b==="body"&&e.body)return p([e.body],f);if(h&&h[3]){var i=e.getElementById(h[3]);if(!i||!i.parentNode)return p([],f);if(i.id===h[3])return p([i],f)}try{return p(e.querySelectorAll(b),f)}catch(j){}}else if(e.nodeType===1&&e.nodeName.toLowerCase()!=="object"){var m=e,n=e.getAttribute("id"),o=n||d,q=e.parentNode,r=/^\s*[+~]/.test(b);n?o=o.replace(/'/g,"\\$&"):e.setAttribute("id",o),r&&q&&(e=e.parentNode);try{if(!r||q)return p(e.querySelectorAll("[id='"+o+"'] "+b),f)}catch(s){}finally{n||m.removeAttribute("id")}}}return a(b,e,f,g)};for(var e in a)k[e]=a[e];b=null}}(),function(){var a=c.documentElement,b=a.matchesSelector||a.mozMatchesSelector||a.webkitMatchesSelector||a.msMatchesSelector;if(b){var d=!b.call(c.createElement("div"),"div"),e=!1;try{b.call(c.documentElement,"[test!='']:sizzle")}catch(f){e=!0}k.matchesSelector=function(a,c){c=c.replace(/\=\s*([^'"\]]*)\s*\]/g,"='$1']");if(!k.isXML(a))try{if(e||!l.match.PSEUDO.test(c)&&!/!=/.test(c)){var f=b.call(a,c);if(f||!d||a.document&&a.document.nodeType!==11)return f}}catch(g){}return k(c,null,null,[a]).length>0}}}(),function(){var a=c.createElement("div");a.innerHTML="<div class='test e'></div><div class='test'></div>";if(a.getElementsByClassName&&a.getElementsByClassName("e").length!==0){a.lastChild.className="e";if(a.getElementsByClassName("e").length===1)return;l.order.splice(1,0,"CLASS"),l.find.CLASS=function(a,b,c){if(typeof b.getElementsByClassName!=="undefined"&&!c)return b.getElementsByClassName(a[1])},a=null}}(),c.documentElement.contains?k.contains=function(a,b){return a!==b&&(a.contains?a.contains(b):!0)}:c.documentElement.compareDocumentPosition?k.contains=function(a,b){return!!(a.compareDocumentPosition(b)&16)}:k.contains=function(){return!1},k.isXML=function(a){var b=(a?a.ownerDocument||a:0).documentElement;return b?b.nodeName!=="HTML":!1};var v=function(a,b){var c,d=[],e="",f=b.nodeType?[b]:b;while(c=l.match.PSEUDO.exec(a))e+=c[0],a=a.replace(l.match.PSEUDO,"");a=l.relative[a]?a+"*":a;for(var g=0,h=f.length;g<h;g++)k(a,f[g],d);return k.filter(e,d)};d.find=k,d.expr=k.selectors,d.expr[":"]=d.expr.filters,d.unique=k.uniqueSort,d.text=k.getText,d.isXMLDoc=k.isXML,d.contains=k.contains}();var I=/Until$/,J=/^(?:parents|prevUntil|prevAll)/,K=/,/,L=/^.[^:#\[\.,]*$/,M=Array.prototype.slice,N=d.expr.match.POS,O={children:!0,contents:!0,next:!0,prev:!0};d.fn.extend({find:function(a){var b=this.pushStack("","find",a),c=0;for(var e=0,f=this.length;e<f;e++){c=b.length,d.find(a,this[e],b);if(e>0)for(var g=c;g<b.length;g++)for(var h=0;h<c;h++)if(b[h]===b[g]){b.splice(g--,1);break}}return b},has:function(a){var b=d(a);return this.filter(function(){for(var a=0,c=b.length;a<c;a++)if(d.contains(this,b[a]))return!0})},not:function(a){return this.pushStack(Q(this,a,!1),"not",a)},filter:function(a){return this.pushStack(Q(this,a,!0),"filter",a)},is:function(a){return!!a&&d.filter(a,this).length>0},closest:function(a,b){var c=[],e,f,g=this[0];if(d.isArray(a)){var h,i,j={},k=1;if(g&&a.length){for(e=0,f=a.length;e<f;e++)i=a[e],j[i]||(j[i]=d.expr.match.POS.test(i)?d(i,b||this.context):i);while(g&&g.ownerDocument&&g!==b){for(i in j)h=j[i],(h.jquery?h.index(g)>-1:d(g).is(h))&&c.push({selector:i,elem:g,level:k});g=g.parentNode,k++}}return c}var l=N.test(a)?d(a,b||this.context):null;for(e=0,f=this.length;e<f;e++){g=this[e];while(g){if(l?l.index(g)>-1:d.find.matchesSelector(g,a)){c.push(g);break}g=g.parentNode;if(!g||!g.ownerDocument||g===b)break}}c=c.length>1?d.unique(c):c;return this.pushStack(c,"closest",a)},index:function(a){if(!a||typeof a==="string")return d.inArray(this[0],a?d(a):this.parent().children());return d.inArray(a.jquery?a[0]:a,this)},add:function(a,b){var c=typeof a==="string"?d(a,b):d.makeArray(a),e=d.merge(this.get(),c);return this.pushStack(P(c[0])||P(e[0])?e:d.unique(e))},andSelf:function(){return this.add(this.prevObject)}}),d.each({parent:function(a){var b=a.parentNode;return b&&b.nodeType!==11?b:null},parents:function(a){return d.dir(a,"parentNode")},parentsUntil:function(a,b,c){return d.dir(a,"parentNode",c)},next:function(a){return d.nth(a,2,"nextSibling")},prev:function(a){return d.nth(a,2,"previousSibling")},nextAll:function(a){return d.dir(a,"nextSibling")},prevAll:function(a){return d.dir(a,"previousSibling")},nextUntil:function(a,b,c){return d.dir(a,"nextSibling",c)},prevUntil:function(a,b,c){return d.dir(a,"previousSibling",c)},siblings:function(a){return d.sibling(a.parentNode.firstChild,a)},children:function(a){return d.sibling(a.firstChild)},contents:function(a){return d.nodeName(a,"iframe")?a.contentDocument||a.contentWindow.document:d.makeArray(a.childNodes)}},function(a,b){d.fn[a]=function(c,e){var f=d.map(this,b,c),g=M.call(arguments);I.test(a)||(e=c),e&&typeof e==="string"&&(f=d.filter(e,f)),f=this.length>1&&!O[a]?d.unique(f):f,(this.length>1||K.test(e))&&J.test(a)&&(f=f.reverse());return this.pushStack(f,a,g.join(","))}}),d.extend({filter:function(a,b,c){c&&(a=":not("+a+")");return b.length===1?d.find.matchesSelector(b[0],a)?[b[0]]:[]:d.find.matches(a,b)},dir:function(a,c,e){var f=[],g=a[c];while(g&&g.nodeType!==9&&(e===b||g.nodeType!==1||!d(g).is(e)))g.nodeType===1&&f.push(g),g=g[c];return f},nth:function(a,b,c,d){b=b||1;var e=0;for(;a;a=a[c])if(a.nodeType===1&&++e===b)break;return a},sibling:function(a,b){var c=[];for(;a;a=a.nextSibling)a.nodeType===1&&a!==b&&c.push(a);return c}});var R=/ jQuery\d+="(?:\d+|null)"/g,S=/^\s+/,T=/<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/ig,U=/<([\w:]+)/,V=/<tbody/i,W=/<|&#?\w+;/,X=/<(?:script|object|embed|option|style)/i,Y=/checked\s*(?:[^=]|=\s*.checked.)/i,Z={option:[1,"<select multiple='multiple'>","</select>"],legend:[1,"<fieldset>","</fieldset>"],thead:[1,"<table>","</table>"],tr:[2,"<table><tbody>","</tbody></table>"],td:[3,"<table><tbody><tr>","</tr></tbody></table>"],col:[2,"<table><tbody></tbody><colgroup>","</colgroup></table>"],area:[1,"<map>","</map>"],_default:[0,"",""]};Z.optgroup=Z.option,Z.tbody=Z.tfoot=Z.colgroup=Z.caption=Z.thead,Z.th=Z.td,d.support.htmlSerialize||(Z._default=[1,"div<div>","</div>"]),d.fn.extend({text:function(a){if(d.isFunction(a))return this.each(function(b){var c=d(this);c.text(a.call(this,b,c.text()))});if(typeof a!=="object"&&a!==b)return this.empty().append((this[0]&&this[0].ownerDocument||c).createTextNode(a));return d.text(this)},wrapAll:function(a){if(d.isFunction(a))return this.each(function(b){d(this).wrapAll(a.call(this,b))});if(this[0]){var b=d(a,this[0].ownerDocument).eq(0).clone(!0);this[0].parentNode&&b.insertBefore(this[0]),b.map(function(){var a=this;while(a.firstChild&&a.firstChild.nodeType===1)a=a.firstChild;return a}).append(this)}return this},wrapInner:function(a){if(d.isFunction(a))return this.each(function(b){d(this).wrapInner(a.call(this,b))});return this.each(function(){var b=d(this),c=b.contents();c.length?c.wrapAll(a):b.append(a)})},wrap:function(a){return this.each(function(){d(this).wrapAll(a)})},unwrap:function(){return this.parent().each(function(){d.nodeName(this,"body")||d(this).replaceWith(this.childNodes)}).end()},append:function(){return this.domManip(arguments,!0,function(a){this.nodeType===1&&this.appendChild(a)})},prepend:function(){return this.domManip(arguments,!0,function(a){this.nodeType===1&&this.insertBefore(a,this.firstChild)})},before:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,!1,function(a){this.parentNode.insertBefore(a,this)});if(arguments.length){var a=d(arguments[0]);a.push.apply(a,this.toArray());return this.pushStack(a,"before",arguments)}},after:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,!1,function(a){this.parentNode.insertBefore(a,this.nextSibling)});if(arguments.length){var a=this.pushStack(this,"after",arguments);a.push.apply(a,d(arguments[0]).toArray());return a}},remove:function(a,b){for(var c=0,e;(e=this[c])!=null;c++)if(!a||d.filter(a,[e]).length)!b&&e.nodeType===1&&(d.cleanData(e.getElementsByTagName("*")),d.cleanData([e])),e.parentNode&&e.parentNode.removeChild(e);return this},empty:function(){for(var a=0,b;(b=this[a])!=null;a++){b.nodeType===1&&d.cleanData(b.getElementsByTagName("*"));while(b.firstChild)b.removeChild(b.firstChild)}return this},clone:function(a,b){a=a==null?!1:a,b=b==null?a:b;return this.map(function(){return d.clone(this,a,b)})},html:function(a){if(a===b)return this[0]&&this[0].nodeType===1?this[0].innerHTML.replace(R,""):null;if(typeof a!=="string"||X.test(a)||!d.support.leadingWhitespace&&S.test(a)||Z[(U.exec(a)||["",""])[1].toLowerCase()])d.isFunction(a)?this.each(function(b){var c=d(this);c.html(a.call(this,b,c.html()))}):this.empty().append(a);else{a=a.replace(T,"<$1></$2>");try{for(var c=0,e=this.length;c<e;c++)this[c].nodeType===1&&(d.cleanData(this[c].getElementsByTagName("*")),this[c].innerHTML=a)}catch(f){this.empty().append(a)}}return this},replaceWith:function(a){if(this[0]&&this[0].parentNode){if(d.isFunction(a))return this.each(function(b){var c=d(this),e=c.html();c.replaceWith(a.call(this,b,e))});typeof a!=="string"&&(a=d(a).detach());return this.each(function(){var b=this.nextSibling,c=this.parentNode;d(this).remove(),b?d(b).before(a):d(c).append(a)})}return this.length?this.pushStack(d(d.isFunction(a)?a():a),"replaceWith",a):this},detach:function(a){return this.remove(a,!0)},domManip:function(a,c,e){var f,g,h,i,j=a[0],k=[];if(!d.support.checkClone&&arguments.length===3&&typeof j==="string"&&Y.test(j))return this.each(function(){d(this).domManip(a,c,e,!0)});if(d.isFunction(j))return this.each(function(f){var g=d(this);a[0]=j.call(this,f,c?g.html():b),g.domManip(a,c,e)});if(this[0]){i=j&&j.parentNode,d.support.parentNode&&i&&i.nodeType===11&&i.childNodes.length===this.length?f={fragment:i}:f=d.buildFragment(a,this,k),h=f.fragment,h.childNodes.length===1?g=h=h.firstChild:g=h.firstChild;if(g){c=c&&d.nodeName(g,"tr");for(var l=0,m=this.length,n=m-1;l<m;l++)e.call(c?$(this[l],g):this[l],f.cacheable||m>1&&l<n?d.clone(h,!0,!0):h)}k.length&&d.each(k,bc)}return this}}),d.buildFragment=function(a,b,e){var f,g,h,i=b&&b[0]?b[0].ownerDocument||b[0]:c;a.length===1&&typeof a[0]==="string"&&a[0].length<512&&i===c&&a[0].charAt(0)==="<"&&!X.test(a[0])&&(d.support.checkClone||!Y.test(a[0]))&&(g=!0,h=d.fragments[a[0]],h&&(h!==1&&(f=h))),f||(f=i.createDocumentFragment(),d.clean(a,i,f,e)),g&&(d.fragments[a[0]]=h?f:1);return{fragment:f,cacheable:g}},d.fragments={},d.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(a,b){d.fn[a]=function(c){var e=[],f=d(c),g=this.length===1&&this[0].parentNode;if(g&&g.nodeType===11&&g.childNodes.length===1&&f.length===1){f[b](this[0]);return this}for(var h=0,i=f.length;h<i;h++){var j=(h>0?this.clone(!0):this).get();d(f[h])[b](j),e=e.concat(j)}return this.pushStack(e,a,f.selector)}}),d.extend({clone:function(a,b,c){var e=a.cloneNode(!0),f,g,h;if((!d.support.noCloneEvent||!d.support.noCloneChecked)&&(a.nodeType===1||a.nodeType===11)&&!d.isXMLDoc(a)){ba(a,e),f=bb(a),g=bb(e);for(h=0;f[h];++h)ba(f[h],g[h])}if(b){_(a,e);if(c){f=bb(a),g=bb(e);for(h=0;f[h];++h)_(f[h],g[h])}}return e},clean:function(a,b,e,f){b=b||c,typeof b.createElement==="undefined"&&(b=b.ownerDocument||b[0]&&b[0].ownerDocument||c);var g=[];for(var h=0,i;(i=a[h])!=null;h++){typeof i==="number"&&(i+="");if(!i)continue;if(typeof i!=="string"||W.test(i)){if(typeof i==="string"){i=i.replace(T,"<$1></$2>");var j=(U.exec(i)||["",""])[1].toLowerCase(),k=Z[j]||Z._default,l=k[0],m=b.createElement("div");m.innerHTML=k[1]+i+k[2];while(l--)m=m.lastChild;if(!d.support.tbody){var n=V.test(i),o=j==="table"&&!n?m.firstChild&&m.firstChild.childNodes:k[1]==="<table>"&&!n?m.childNodes:[];for(var p=o.length-1;p>=0;--p)d.nodeName(o[p],"tbody")&&!o[p].childNodes.length&&o[p].parentNode.removeChild(o[p])}!d.support.leadingWhitespace&&S.test(i)&&m.insertBefore(b.createTextNode(S.exec(i)[0]),m.firstChild),i=m.childNodes}}else i=b.createTextNode(i);i.nodeType?g.push(i):g=d.merge(g,i)}if(e)for(h=0;g[h];h++)!f||!d.nodeName(g[h],"script")||g[h].type&&g[h].type.toLowerCase()!=="text/javascript"?(g[h].nodeType===1&&g.splice.apply(g,[h+1,0].concat(d.makeArray(g[h].getElementsByTagName("script")))),e.appendChild(g[h])):f.push(g[h].parentNode?g[h].parentNode.removeChild(g[h]):g[h]);return g},cleanData:function(a){var b,c,e=d.cache,f=d.expando,g=d.event.special,h=d.support.deleteExpando;for(var i=0,j;(j=a[i])!=null;i++){if(j.nodeName&&d.noData[j.nodeName.toLowerCase()])continue;c=j[d.expando];if(c){b=e[c]&&e[c][f];if(b&&b.events){for(var k in b.events)g[k]?d.event.remove(j,k):d.removeEvent(j,k,b.handle);b.handle&&(b.handle.elem=null)}h?delete j[d.expando]:j.removeAttribute&&j.removeAttribute(d.expando),delete e[c]}}}});var bd=/alpha\([^)]*\)/i,be=/opacity=([^)]*)/,bf=/-([a-z])/ig,bg=/([A-Z]|^ms)/g,bh=/^-?\d+(?:px)?$/i,bi=/^-?\d/,bj={position:"absolute",visibility:"hidden",display:"block"},bk=["Left","Right"],bl=["Top","Bottom"],bm,bn,bo,bp=function(a,b){return b.toUpperCase()};d.fn.css=function(a,c){if(arguments.length===2&&c===b)return this;return d.access(this,a,c,!0,function(a,c,e){return e!==b?d.style(a,c,e):d.css(a,c)})},d.extend({cssHooks:{opacity:{get:function(a,b){if(b){var c=bm(a,"opacity","opacity");return c===""?"1":c}return a.style.opacity}}},cssNumber:{zIndex:!0,fontWeight:!0,opacity:!0,zoom:!0,lineHeight:!0},cssProps:{"float":d.support.cssFloat?"cssFloat":"styleFloat"},style:function(a,c,e,f){if(a&&a.nodeType!==3&&a.nodeType!==8&&a.style){var g,h=d.camelCase(c),i=a.style,j=d.cssHooks[h];c=d.cssProps[h]||h;if(e===b){if(j&&"get"in j&&(g=j.get(a,!1,f))!==b)return g;return i[c]}if(typeof e==="number"&&isNaN(e)||e==null)return;typeof e==="number"&&!d.cssNumber[h]&&(e+="px");if(!j||!("set"in j)||(e=j.set(a,e))!==b)try{i[c]=e}catch(k){}}},css:function(a,c,e){var f,g=d.camelCase(c),h=d.cssHooks[g];c=d.cssProps[g]||g;if(h&&"get"in h&&(f=h.get(a,!0,e))!==b)return f;if(bm)return bm(a,c,g)},swap:function(a,b,c){var d={};for(var e in b)d[e]=a.style[e],a.style[e]=b[e];c.call(a);for(e in b)a.style[e]=d[e]},camelCase:function(a){return a.replace(bf,bp)}}),d.curCSS=d.css,d.each(["height","width"],function(a,b){d.cssHooks[b]={get:function(a,c,e){var f;if(c){a.offsetWidth!==0?f=bq(a,b,e):d.swap(a,bj,function(){f=bq(a,b,e)});if(f<=0){f=bm(a,b,b),f==="0px"&&bo&&(f=bo(a,b,b));if(f!=null)return f===""||f==="auto"?"0px":f}if(f<0||f==null){f=a.style[b];return f===""||f==="auto"?"0px":f}return typeof f==="string"?f:f+"px"}},set:function(a,b){if(!bh.test(b))return b;b=parseFloat(b);if(b>=0)return b+"px"}}}),d.support.opacity||(d.cssHooks.opacity={get:function(a,b){return be.test((b&&a.currentStyle?a.currentStyle.filter:a.style.filter)||"")?parseFloat(RegExp.$1)/100+"":b?"1":""},set:function(a,b){var c=a.style;c.zoom=1;var e=d.isNaN(b)?"":"alpha(opacity="+b*100+")",f=c.filter||"";c.filter=bd.test(f)?f.replace(bd,e):c.filter+" "+e}}),d(function(){d.support.reliableMarginRight||(d.cssHooks.marginRight={get:function(a,b){var c;d.swap(a,{display:"inline-block"},function(){b?c=bm(a,"margin-right","marginRight"):c=a.style.marginRight});return c}})}),c.defaultView&&c.defaultView.getComputedStyle&&(bn=function(a,c,e){var f,g,h;e=e.replace(bg,"-$1").toLowerCase();if(!(g=a.ownerDocument.defaultView))return b;if(h=g.getComputedStyle(a,null))f=h.getPropertyValue(e),f===""&&!d.contains(a.ownerDocument.documentElement,a)&&(f=d.style(a,e));return f}),c.documentElement.currentStyle&&(bo=function(a,b){var c,d=a.currentStyle&&a.currentStyle[b],e=a.runtimeStyle&&a.runtimeStyle[b],f=a.style;!bh.test(d)&&bi.test(d)&&(c=f.left,e&&(a.runtimeStyle.left=a.currentStyle.left),f.left=b==="fontSize"?"1em":d||0,d=f.pixelLeft+"px",f.left=c,e&&(a.runtimeStyle.left=e));return d===""?"auto":d}),bm=bn||bo,d.expr&&d.expr.filters&&(d.expr.filters.hidden=function(a){var b=a.offsetWidth,c=a.offsetHeight;return b===0&&c===0||!d.support.reliableHiddenOffsets&&(a.style.display||d.css(a,"display"))==="none"},d.expr.filters.visible=function(a){return!d.expr.filters.hidden(a)});var br=/%20/g,bs=/\[\]$/,bt=/\r?\n/g,bu=/#.*$/,bv=/^(.*?):[ \t]*([^\r\n]*)\r?$/mg,bw=/^(?:color|date|datetime|email|hidden|month|number|password|range|search|tel|text|time|url|week)$/i,bx=/^(?:about|app|app\-storage|.+\-extension|file|widget):$/,by=/^(?:GET|HEAD)$/,bz=/^\/\//,bA=/\?/,bB=/<script\b[^<]*(?:(?!<\/script>)<[^<]*)*<\/script>/gi,bC=/^(?:select|textarea)/i,bD=/\s+/,bE=/([?&])_=[^&]*/,bF=/(^|\-)([a-z])/g,bG=function(a,b,c){return b+c.toUpperCase()},bH=/^([\w\+\.\-]+:)(?:\/\/([^\/?#:]*)(?::(\d+))?)?/,bI=d.fn.load,bJ={},bK={},bL,bM;try{bL=c.location.href}catch(bN){bL=c.createElement("a"),bL.href="",bL=bL.href}bM=bH.exec(bL.toLowerCase())||[],d.fn.extend({load:function(a,c,e){if(typeof a!=="string"&&bI)return bI.apply(this,arguments);if(!this.length)return this;var f=a.indexOf(" ");if(f>=0){var g=a.slice(f,a.length);a=a.slice(0,f)}var h="GET";c&&(d.isFunction(c)?(e=c,c=b):typeof c==="object"&&(c=d.param(c,d.ajaxSettings.traditional),h="POST"));var i=this;d.ajax({url:a,type:h,dataType:"html",data:c,complete:function(a,b,c){c=a.responseText,a.isResolved()&&(a.done(function(a){c=a}),i.html(g?d("<div>").append(c.replace(bB,"")).find(g):c)),e&&i.each(e,[c,b,a])}});return this},serialize:function(){return d.param(this.serializeArray())},serializeArray:function(){return this.map(function(){return this.elements?d.makeArray(this.elements):this}).filter(function(){return this.name&&!this.disabled&&(this.checked||bC.test(this.nodeName)||bw.test(this.type))}).map(function(a,b){var c=d(this).val();return c==null?null:d.isArray(c)?d.map(c,function(a,c){return{name:b.name,value:a.replace(bt,"\r\n")}}):{name:b.name,value:c.replace(bt,"\r\n")}}).get()}}),d.each("ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend".split(" "),function(a,b){d.fn[b]=function(a){return this.bind(b,a)}}),d.each(["get","post"],function(a,c){d[c]=function(a,e,f,g){d.isFunction(e)&&(g=g||f,f=e,e=b);return d.ajax({type:c,url:a,data:e,success:f,dataType:g})}}),d.extend({getScript:function(a,c){return d.get(a,b,c,"script")},getJSON:function(a,b,c){return d.get(a,b,c,"json")},ajaxSetup:function(a,b){b?d.extend(!0,a,d.ajaxSettings,b):(b=a,a=d.extend(!0,d.ajaxSettings,b));for(var c in {context:1,url:1})c in b?a[c]=b[c]:c in d.ajaxSettings&&(a[c]=d.ajaxSettings[c]);return a},ajaxSettings:{url:bL,isLocal:bx.test(bM[1]),global:!0,type:"GET",contentType:"application/x-www-form-urlencoded",processData:!0,async:!0,accepts:{xml:"application/xml, text/xml",html:"text/html",text:"text/plain",json:"application/json, text/javascript","*":"*/*"},contents:{xml:/xml/,html:/html/,json:/json/},responseFields:{xml:"responseXML",text:"responseText"},converters:{"* text":a.String,"text html":!0,"text json":d.parseJSON,"text xml":d.parseXML}},ajaxPrefilter:bO(bJ),ajaxTransport:bO(bK),ajax:function(a,c){function v(a,c,l,n){if(r!==2){r=2,p&&clearTimeout(p),o=b,m=n||"",u.readyState=a?4:0;var q,t,v,w=l?bR(e,u,l):b,x,y;if(a>=200&&a<300||a===304){if(e.ifModified){if(x=u.getResponseHeader("Last-Modified"))d.lastModified[k]=x;if(y=u.getResponseHeader("Etag"))d.etag[k]=y}if(a===304)c="notmodified",q=!0;else try{t=bS(e,w),c="success",q=!0}catch(z){c="parsererror",v=z}}else{v=c;if(!c||a)c="error",a<0&&(a=0)}u.status=a,u.statusText=c,q?h.resolveWith(f,[t,c,u]):h.rejectWith(f,[u,c,v]),u.statusCode(j),j=b,s&&g.trigger("ajax"+(q?"Success":"Error"),[u,e,q?t:v]),i.resolveWith(f,[u,c]),s&&(g.trigger("ajaxComplete",[u,e]),--d.active||d.event.trigger("ajaxStop"))}}typeof a==="object"&&(c=a,a=b),c=c||{};var e=d.ajaxSetup({},c),f=e.context||e,g=f!==e&&(f.nodeType||f instanceof d)?d(f):d.event,h=d.Deferred(),i=d._Deferred(),j=e.statusCode||{},k,l={},m,n,o,p,q,r=0,s,t,u={readyState:0,setRequestHeader:function(a,b){r||(l[a.toLowerCase().replace(bF,bG)]=b);return this},getAllResponseHeaders:function(){return r===2?m:null},getResponseHeader:function(a){var c;if(r===2){if(!n){n={};while(c=bv.exec(m))n[c[1].toLowerCase()]=c[2]}c=n[a.toLowerCase()]}return c===b?null:c},overrideMimeType:function(a){r||(e.mimeType=a);return this},abort:function(a){a=a||"abort",o&&o.abort(a),v(0,a);return this}};h.promise(u),u.success=u.done,u.error=u.fail,u.complete=i.done,u.statusCode=function(a){if(a){var b;if(r<2)for(b in a)j[b]=[j[b],a[b]];else b=a[u.status],u.then(b,b)}return this},e.url=((a||e.url)+"").replace(bu,"").replace(bz,bM[1]+"//"),e.dataTypes=d.trim(e.dataType||"*").toLowerCase().split(bD),e.crossDomain==null&&(q=bH.exec(e.url.toLowerCase()),e.crossDomain=q&&(q[1]!=bM[1]||q[2]!=bM[2]||(q[3]||(q[1]==="http:"?80:443))!=(bM[3]||(bM[1]==="http:"?80:443)))),e.data&&e.processData&&typeof e.data!=="string"&&(e.data=d.param(e.data,e.traditional)),bP(bJ,e,c,u);if(r===2)return!1;s=e.global,e.type=e.type.toUpperCase(),e.hasContent=!by.test(e.type),s&&d.active++===0&&d.event.trigger("ajaxStart");if(!e.hasContent){e.data&&(e.url+=(bA.test(e.url)?"&":"?")+e.data),k=e.url;if(e.cache===!1){var w=d.now(),x=e.url.replace(bE,"$1_="+w);e.url=x+(x===e.url?(bA.test(e.url)?"&":"?")+"_="+w:"")}}if(e.data&&e.hasContent&&e.contentType!==!1||c.contentType)l["Content-Type"]=e.contentType;e.ifModified&&(k=k||e.url,d.lastModified[k]&&(l["If-Modified-Since"]=d.lastModified[k]),d.etag[k]&&(l["If-None-Match"]=d.etag[k])),l.Accept=e.dataTypes[0]&&e.accepts[e.dataTypes[0]]?e.accepts[e.dataTypes[0]]+(e.dataTypes[0]!=="*"?", */*; q=0.01":""):e.accepts["*"];for(t in e.headers)u.setRequestHeader(t,e.headers[t]);if(e.beforeSend&&(e.beforeSend.call(f,u,e)===!1||r===2)){u.abort();return!1}for(t in {success:1,error:1,complete:1})u[t](e[t]);o=bP(bK,e,c,u);if(o){u.readyState=1,s&&g.trigger("ajaxSend",[u,e]),e.async&&e.timeout>0&&(p=setTimeout(function(){u.abort("timeout")},e.timeout));try{r=1,o.send(l,v)}catch(y){status<2?v(-1,y):d.error(y)}}else v(-1,"No Transport");return u},param:function(a,c){var e=[],f=function(a,b){b=d.isFunction(b)?b():b,e[e.length]=encodeURIComponent(a)+"="+encodeURIComponent(b)};c===b&&(c=d.ajaxSettings.traditional);if(d.isArray(a)||a.jquery&&!d.isPlainObject(a))d.each(a,function(){f(this.name,this.value)});else for(var g in a)bQ(g,a[g],c,f);return e.join("&").replace(br,"+")}}),d.extend({active:0,lastModified:{},etag:{}});var bT=d.now(),bU=/(\=)\?(&|$)|\?\?/i;d.ajaxSetup({jsonp:"callback",jsonpCallback:function(){return d.expando+"_"+bT++}}),d.ajaxPrefilter("json jsonp",function(b,c,e){var f=typeof b.data==="string";if(b.dataTypes[0]==="jsonp"||c.jsonpCallback||c.jsonp!=null||b.jsonp!==!1&&(bU.test(b.url)||f&&bU.test(b.data))){var g,h=b.jsonpCallback=d.isFunction(b.jsonpCallback)?b.jsonpCallback():b.jsonpCallback,i=a[h],j=b.url,k=b.data,l="$1"+h+"$2",m=function(){a[h]=i,g&&d.isFunction(i)&&a[h](g[0])};b.jsonp!==!1&&(j=j.replace(bU,l),b.url===j&&(f&&(k=k.replace(bU,l)),b.data===k&&(j+=(/\?/.test(j)?"&":"?")+b.jsonp+"="+h))),b.url=j,b.data=k,a[h]=function(a){g=[a]},e.then(m,m),b.converters["script json"]=function(){g||d.error(h+" was not called");return g[0]},b.dataTypes[0]="json";return"script"}}),d.ajaxSetup({accepts:{script:"text/javascript, application/javascript, application/ecmascript, application/x-ecmascript"},contents:{script:/javascript|ecmascript/},converters:{"text script":function(a){d.globalEval(a);return a}}}),d.ajaxPrefilter("script",function(a){a.cache===b&&(a.cache=!1),a.crossDomain&&(a.type="GET",a.global=!1)}),d.ajaxTransport("script",function(a){if(a.crossDomain){var d,e=c.head||c.getElementsByTagName("head")[0]||c.documentElement;return{send:function(f,g){d=c.createElement("script"),d.async="async",a.scriptCharset&&(d.charset=a.scriptCharset),d.src=a.url,d.onload=d.onreadystatechange=function(a,c){if(!d.readyState||/loaded|complete/.test(d.readyState))d.onload=d.onreadystatechange=null,e&&d.parentNode&&e.removeChild(d),d=b,c||g(200,"success")},e.insertBefore(d,e.firstChild)},abort:function(){d&&d.onload(0,1)}}}});var bV=d.now(),bW,bX;d.ajaxSettings.xhr=a.ActiveXObject?function(){return!this.isLocal&&bZ()||b$()}:bZ,bX=d.ajaxSettings.xhr(),d.support.ajax=!!bX,d.support.cors=bX&&"withCredentials"in bX,bX=b,d.support.ajax&&d.ajaxTransport(function(a){if(!a.crossDomain||d.support.cors){var c;return{send:function(e,f){var g=a.xhr(),h,i;a.username?g.open(a.type,a.url,a.async,a.username,a.password):g.open(a.type,a.url,a.async);if(a.xhrFields)for(i in a.xhrFields)g[i]=a.xhrFields[i];a.mimeType&&g.overrideMimeType&&g.overrideMimeType(a.mimeType),!a.crossDomain&&!e["X-Requested-With"]&&(e["X-Requested-With"]="XMLHttpRequest");try{for(i in e)g.setRequestHeader(i,e[i])}catch(j){}g.send(a.hasContent&&a.data||null),c=function(e,i){var j,k,l,m,n;try{if(c&&(i||g.readyState===4)){c=b,h&&(g.onreadystatechange=d.noop,delete bW[h]);if(i)g.readyState!==4&&g.abort();else{j=g.status,l=g.getAllResponseHeaders(),m={},n=g.responseXML,n&&n.documentElement&&(m.xml=n),m.text=g.responseText;try{k=g.statusText}catch(o){k=""}j||!a.isLocal||a.crossDomain?j===1223&&(j=204):j=m.text?200:404}}}catch(p){i||f(-1,p)}m&&f(j,k,m,l)},a.async&&g.readyState!==4?(bW||(bW={},bY()),h=bV++,g.onreadystatechange=bW[h]=c):c()},abort:function(){c&&c(0,1)}}}});var b_={},ca=/^(?:toggle|show|hide)$/,cb=/^([+\-]=)?([\d+.\-]+)([a-z%]*)$/i,cc,cd=[["height","marginTop","marginBottom","paddingTop","paddingBottom"],["width","marginLeft","marginRight","paddingLeft","paddingRight"],["opacity"]];d.fn.extend({show:function(a,b,c){var e,f;if(a||a===0)return this.animate(ce("show",3),a,b,c);for(var g=0,h=this.length;g<h;g++)e=this[g],f=e.style.display,!d._data(e,"olddisplay")&&f==="none"&&(f=e.style.display=""),f===""&&d.css(e,"display")==="none"&&d._data(e,"olddisplay",cf(e.nodeName));for(g=0;g<h;g++){e=this[g],f=e.style.display;if(f===""||f==="none")e.style.display=d._data(e,"olddisplay")||""}return this},hide:function(a,b,c){if(a||a===0)return this.animate(ce("hide",3),a,b,c);for(var e=0,f=this.length;e<f;e++){var g=d.css(this[e],"display");g!=="none"&&!d._data(this[e],"olddisplay")&&d._data(this[e],"olddisplay",g)}for(e=0;e<f;e++)this[e].style.display="none";return this},_toggle:d.fn.toggle,toggle:function(a,b,c){var e=typeof a==="boolean";d.isFunction(a)&&d.isFunction(b)?this._toggle.apply(this,arguments):a==null||e?this.each(function(){var b=e?a:d(this).is(":hidden");d(this)[b?"show":"hide"]()}):this.animate(ce("toggle",3),a,b,c);return this},fadeTo:function(a,b,c,d){return this.filter(":hidden").css("opacity",0).show().end().animate({opacity:b},a,c,d)},animate:function(a,b,c,e){var f=d.speed(b,c,e);if(d.isEmptyObject(a))return this.each(f.complete);return this[f.queue===!1?"each":"queue"](function(){var b=d.extend({},f),c,e=this.nodeType===1,g=e&&d(this).is(":hidden"),h=this;for(c in a){var i=d.camelCase(c);c!==i&&(a[i]=a[c],delete a[c],c=i);if(a[c]==="hide"&&g||a[c]==="show"&&!g)return b.complete.call(this);if(e&&(c==="height"||c==="width")){b.overflow=[this.style.overflow,this.style.overflowX,this.style.overflowY];if(d.css(this,"display")==="inline"&&d.css(this,"float")==="none")if(d.support.inlineBlockNeedsLayout){var j=cf(this.nodeName);j==="inline"?this.style.display="inline-block":(this.style.display="inline",this.style.zoom=1)}else this.style.display="inline-block"}d.isArray(a[c])&&((b.specialEasing=b.specialEasing||{})[c]=a[c][1],a[c]=a[c][0])}b.overflow!=null&&(this.style.overflow="hidden"),b.curAnim=d.extend({},a),d.each(a,function(c,e){var f=new d.fx(h,b,c);if(ca.test(e))f[e==="toggle"?g?"show":"hide":e](a);else{var i=cb.exec(e),j=f.cur();if(i){var k=parseFloat(i[2]),l=i[3]||(d.cssNumber[c]?"":"px");l!=="px"&&(d.style(h,c,(k||1)+l),j=(k||1)/f.cur()*j,d.style(h,c,j+l)),i[1]&&(k=(i[1]==="-="?-1:1)*k+j),f.custom(j,k,l)}else f.custom(j,e,"")}});return!0})},stop:function(a,b){var c=d.timers;a&&this.queue([]),this.each(function(){for(var a=c.length-1;a>=0;a--)c[a].elem===this&&(b&&c[a](!0),c.splice(a,1))}),b||this.dequeue();return this}}),d.each({slideDown:ce("show",1),slideUp:ce("hide",1),slideToggle:ce("toggle",1),fadeIn:{opacity:"show"},fadeOut:{opacity:"hide"},fadeToggle:{opacity:"toggle"}},function(a,b){d.fn[a]=function(a,c,d){return this.animate(b,a,c,d)}}),d.extend({speed:function(a,b,c){var e=a&&typeof a==="object"?d.extend({},a):{complete:c||!c&&b||d.isFunction(a)&&a,duration:a,easing:c&&b||b&&!d.isFunction(b)&&b};e.duration=d.fx.off?0:typeof e.duration==="number"?e.duration:e.duration in d.fx.speeds?d.fx.speeds[e.duration]:d.fx.speeds._default,e.old=e.complete,e.complete=function(){e.queue!==!1&&d(this).dequeue(),d.isFunction(e.old)&&e.old.call(this)};return e},easing:{linear:function(a,b,c,d){return c+d*a},swing:function(a,b,c,d){return(-Math.cos(a*Math.PI)/2+.5)*d+c}},timers:[],fx:function(a,b,c){this.options=b,this.elem=a,this.prop=c,b.orig||(b.orig={})}}),d.fx.prototype={update:function(){this.options.step&&this.options.step.call(this.elem,this.now,this),(d.fx.step[this.prop]||d.fx.step._default)(this)},cur:function(){if(this.elem[this.prop]!=null&&(!this.elem.style||this.elem.style[this.prop]==null))return this.elem[this.prop];var a,b=d.css(this.elem,this.prop);return isNaN(a=parseFloat(b))?!b||b==="auto"?0:b:a},custom:function(a,b,c){function g(a){return e.step(a)}var e=this,f=d.fx;this.startTime=d.now(),this.start=a,this.end=b,this.unit=c||this.unit||(d.cssNumber[this.prop]?"":"px"),this.now=this.start,this.pos=this.state=0,g.elem=this.elem,g()&&d.timers.push(g)&&!cc&&(cc=setInterval(f.tick,f.interval))},show:function(){this.options.orig[this.prop]=d.style(this.elem,this.prop),this.options.show=!0,this.custom(this.prop==="width"||this.prop==="height"?1:0,this.cur()),d(this.elem).show()},hide:function(){this.options.orig[this.prop]=d.style(this.elem,this.prop),this.options.hide=!0,this.custom(this.cur(),0)},step:function(a){var b=d.now(),c=!0;if(a||b>=this.options.duration+this.startTime){this.now=this.end,this.pos=this.state=1,this.update(),this.options.curAnim[this.prop]=!0;for(var e in this.options.curAnim)this.options.curAnim[e]!==!0&&(c=!1);if(c){if(this.options.overflow!=null&&!d.support.shrinkWrapBlocks){var f=this.elem,g=this.options;d.each(["","X","Y"],function(a,b){f.style["overflow"+b]=g.overflow[a]})}this.options.hide&&d(this.elem).hide();if(this.options.hide||this.options.show)for(var h in this.options.curAnim)d.style(this.elem,h,this.options.orig[h]);this.options.complete.call(this.elem)}return!1}var i=b-this.startTime;this.state=i/this.options.duration;var j=this.options.specialEasing&&this.options.specialEasing[this.prop],k=this.options.easing||(d.easing.swing?"swing":"linear");this.pos=d.easing[j||k](this.state,i,0,1,this.options.duration),this.now=this.start+(this.end-this.start)*this.pos,this.update();return!0}},d.extend(d.fx,{tick:function(){var a=d.timers;for(var b=0;b<a.length;b++)a[b]()||a.splice(b--,1);a.length||d.fx.stop()},interval:13,stop:function(){clearInterval(cc),cc=null},speeds:{slow:600,fast:200,_default:400},step:{opacity:function(a){d.style(a.elem,"opacity",a.now)},_default:function(a){a.elem.style&&a.elem.style[a.prop]!=null?a.elem.style[a.prop]=(a.prop==="width"||a.prop==="height"?Math.max(0,a.now):a.now)+a.unit:a.elem[a.prop]=a.now}}}),d.expr&&d.expr.filters&&(d.expr.filters.animated=function(a){return d.grep(d.timers,function(b){return a===b.elem}).length});var cg=/^t(?:able|d|h)$/i,ch=/^(?:body|html)$/i;"getBoundingClientRect"in c.documentElement?d.fn.offset=function(a){var b=this[0],c;if(a)return this.each(function(b){d.offset.setOffset(this,a,b)});if(!b||!b.ownerDocument)return null;if(b===b.ownerDocument.body)return d.offset.bodyOffset(b);try{c=b.getBoundingClientRect()}catch(e){}var f=b.ownerDocument,g=f.documentElement;if(!c||!d.contains(g,b))return c?{top:c.top,left:c.left}:{top:0,left:0};var h=f.body,i=ci(f),j=g.clientTop||h.clientTop||0,k=g.clientLeft||h.clientLeft||0,l=i.pageYOffset||d.support.boxModel&&g.scrollTop||h.scrollTop,m=i.pageXOffset||d.support.boxModel&&g.scrollLeft||h.scrollLeft,n=c.top+l-j,o=c.left+m-k;return{top:n,left:o}}:d.fn.offset=function(a){var b=this[0];if(a)return this.each(function(b){d.offset.setOffset(this,a,b)});if(!b||!b.ownerDocument)return null;if(b===b.ownerDocument.body)return d.offset.bodyOffset(b);d.offset.initialize();var c,e=b.offsetParent,f=b,g=b.ownerDocument,h=g.documentElement,i=g.body,j=g.defaultView,k=j?j.getComputedStyle(b,null):b.currentStyle,l=b.offsetTop,m=b.offsetLeft;while((b=b.parentNode)&&b!==i&&b!==h){if(d.offset.supportsFixedPosition&&k.position==="fixed")break;c=j?j.getComputedStyle(b,null):b.currentStyle,l-=b.scrollTop,m-=b.scrollLeft,b===e&&(l+=b.offsetTop,m+=b.offsetLeft,d.offset.doesNotAddBorder&&(!d.offset.doesAddBorderForTableAndCells||!cg.test(b.nodeName))&&(l+=parseFloat(c.borderTopWidth)||0,m+=parseFloat(c.borderLeftWidth)||0),f=e,e=b.offsetParent),d.offset.subtractsBorderForOverflowNotVisible&&c.overflow!=="visible"&&(l+=parseFloat(c.borderTopWidth)||0,m+=parseFloat(c.borderLeftWidth)||0),k=c}if(k.position==="relative"||k.position==="static")l+=i.offsetTop,m+=i.offsetLeft;d.offset.supportsFixedPosition&&k.position==="fixed"&&(l+=Math.max(h.scrollTop,i.scrollTop),m+=Math.max(h.scrollLeft,i.scrollLeft));return{top:l,left:m}},d.offset={initialize:function(){var a=c.body,b=c.createElement("div"),e,f,g,h,i=parseFloat(d.css(a,"marginTop"))||0,j="<div style='position:absolute;top:0;left:0;margin:0;border:5px solid #000;padding:0;width:1px;height:1px;'><div></div></div><table style='position:absolute;top:0;left:0;margin:0;border:5px solid #000;padding:0;width:1px;height:1px;' cellpadding='0' cellspacing='0'><tr><td></td></tr></table>";d.extend(b.style,{position:"absolute",top:0,left:0,margin:0,border:0,width:"1px",height:"1px",visibility:"hidden"}),b.innerHTML=j,a.insertBefore(b,a.firstChild),e=b.firstChild,f=e.firstChild,h=e.nextSibling.firstChild.firstChild,this.doesNotAddBorder=f.offsetTop!==5,this.doesAddBorderForTableAndCells=h.offsetTop===5,f.style.position="fixed",f.style.top="20px",this.supportsFixedPosition=f.offsetTop===20||f.offsetTop===15,f.style.position=f.style.top="",e.style.overflow="hidden",e.style.position="relative",this.subtractsBorderForOverflowNotVisible=f.offsetTop===-5,this.doesNotIncludeMarginInBodyOffset=a.offsetTop!==i,a.removeChild(b),d.offset.initialize=d.noop},bodyOffset:function(a){var b=a.offsetTop,c=a.offsetLeft;d.offset.initialize(),d.offset.doesNotIncludeMarginInBodyOffset&&(b+=parseFloat(d.css(a,"marginTop"))||0,c+=parseFloat(d.css(a,"marginLeft"))||0);return{top:b,left:c}},setOffset:function(a,b,c){var e=d.css(a,"position");e==="static"&&(a.style.position="relative");var f=d(a),g=f.offset(),h=d.css(a,"top"),i=d.css(a,"left"),j=(e==="absolute"||e==="fixed")&&d.inArray("auto",[h,i])>-1,k={},l={},m,n;j&&(l=f.position()),m=j?l.top:parseInt(h,10)||0,n=j?l.left:parseInt(i,10)||0,d.isFunction(b)&&(b=b.call(a,c,g)),b.top!=null&&(k.top=b.top-g.top+m),b.left!=null&&(k.left=b.left-g.left+n),"using"in b?b.using.call(a,k):f.css(k)}},d.fn.extend({position:function(){if(!this[0])return null;var a=this[0],b=this.offsetParent(),c=this.offset(),e=ch.test(b[0].nodeName)?{top:0,left:0}:b.offset();c.top-=parseFloat(d.css(a,"marginTop"))||0,c.left-=parseFloat(d.css(a,"marginLeft"))||0,e.top+=parseFloat(d.css(b[0],"borderTopWidth"))||0,e.left+=parseFloat(d.css(b[0],"borderLeftWidth"))||0;return{top:c.top-e.top,left:c.left-e.left}},offsetParent:function(){return this.map(function(){var a=this.offsetParent||c.body;while(a&&(!ch.test(a.nodeName)&&d.css(a,"position")==="static"))a=a.offsetParent;return a})}}),d.each(["Left","Top"],function(a,c){var e="scroll"+c;d.fn[e]=function(c){var f=this[0],g;if(!f)return null;if(c!==b)return this.each(function(){g=ci(this),g?g.scrollTo(a?d(g).scrollLeft():c,a?c:d(g).scrollTop()):this[e]=c});g=ci(f);return g?"pageXOffset"in g?g[a?"pageYOffset":"pageXOffset"]:d.support.boxModel&&g.document.documentElement[e]||g.document.body[e]:f[e]}}),d.each(["Height","Width"],function(a,c){var e=c.toLowerCase();d.fn["inner"+c]=function(){return this[0]?parseFloat(d.css(this[0],e,"padding")):null},d.fn["outer"+c]=function(a){return this[0]?parseFloat(d.css(this[0],e,a?"margin":"border")):null},d.fn[e]=function(a){var f=this[0];if(!f)return a==null?null:this;if(d.isFunction(a))return this.each(function(b){var c=d(this);c[e](a.call(this,b,c[e]()))});if(d.isWindow(f)){var g=f.document.documentElement["client"+c];return f.document.compatMode==="CSS1Compat"&&g||f.document.body["client"+c]||g}if(f.nodeType===9)return Math.max(f.documentElement["client"+c],f.body["scroll"+c],f.documentElement["scroll"+c],f.body["offset"+c],f.documentElement["offset"+c]);if(a===b){var h=d.css(f,e),i=parseFloat(h);return d.isNaN(i)?h:i}return this.css(e,typeof a==="string"?a:a+"px")}}),a.jQuery=a.$=d})(window);
\ No newline at end of file diff --git a/doc/method_list.html b/doc/method_list.html new file mode 100644 index 00000000..80d1dc52 --- /dev/null +++ b/doc/method_list.html @@ -0,0 +1,2902 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <link rel="stylesheet" href="css/full_list.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" src="js/jquery.js"></script> + + <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script> + + + <base id="base_target" target="_parent" /> + </head> + <body> + <script type="text/javascript" charset="utf-8"> + if (window.top.frames.main) { + document.getElementById('base_target').target = 'main'; + document.body.className = 'frames'; + } + </script> + <div id="content"> + <h1 id="full_list_header">Method List</h1> + <div id="nav"> + + <a target="_self" href="class_list.html">Classes</a> + + <a target="_self" href="method_list.html">Methods</a> + + <a target="_self" href="file_list.html">Files</a> + + </div> + <div id="search">Search: <input type="text" /></div> + + <ul id="full_list" class="methods"> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/SimpleTypedList.html#%3C%3C-instance_method" title="Axlsx::SimpleTypedList#<< (method)">#<<</a></span> + + <small>Axlsx::SimpleTypedList</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/App.html#AppVersion-instance_method" title="Axlsx::App#AppVersion (method)">#AppVersion</a></span> + + <small>Axlsx::App</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/App.html#Application-instance_method" title="Axlsx::App#Application (method)">#Application</a></span> + + <small>Axlsx::App</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/App.html#Characters-instance_method" title="Axlsx::App#Characters (method)">#Characters</a></span> + + <small>Axlsx::App</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/App.html#CharactersWithSpaces-instance_method" title="Axlsx::App#CharactersWithSpaces (method)">#CharactersWithSpaces</a></span> + + <small>Axlsx::App</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/App.html#Company-instance_method" title="Axlsx::App#Company (method)">#Company</a></span> + + <small>Axlsx::App</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Override.html#ContentType-instance_method" title="Axlsx::Override#ContentType (method)">#ContentType</a></span> + + <small>Axlsx::Override</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Default.html#ContentType-instance_method" title="Axlsx::Default#ContentType (method)">#ContentType</a></span> + + <small>Axlsx::Default</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/App.html#DocSecurity-instance_method" title="Axlsx::App#DocSecurity (method)">#DocSecurity</a></span> + + <small>Axlsx::App</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Default.html#Extension-instance_method" title="Axlsx::Default#Extension (method)">#Extension</a></span> + + <small>Axlsx::Default</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/App.html#HiddenSlides-instance_method" title="Axlsx::App#HiddenSlides (method)">#HiddenSlides</a></span> + + <small>Axlsx::App</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/App.html#HyperLinkBase-instance_method" title="Axlsx::App#HyperLinkBase (method)">#HyperLinkBase</a></span> + + <small>Axlsx::App</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/App.html#HyperlinksChanged-instance_method" title="Axlsx::App#HyperlinksChanged (method)">#HyperlinksChanged</a></span> + + <small>Axlsx::App</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/App.html#Lines-instance_method" title="Axlsx::App#Lines (method)">#Lines</a></span> + + <small>Axlsx::App</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/App.html#LinksUpToDate-instance_method" title="Axlsx::App#LinksUpToDate (method)">#LinksUpToDate</a></span> + + <small>Axlsx::App</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/App.html#MMClips-instance_method" title="Axlsx::App#MMClips (method)">#MMClips</a></span> + + <small>Axlsx::App</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/App.html#Manager-instance_method" title="Axlsx::App#Manager (method)">#Manager</a></span> + + <small>Axlsx::App</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/App.html#Notes-instance_method" title="Axlsx::App#Notes (method)">#Notes</a></span> + + <small>Axlsx::App</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/App.html#Pages-instance_method" title="Axlsx::App#Pages (method)">#Pages</a></span> + + <small>Axlsx::App</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/App.html#Paragraphs-instance_method" title="Axlsx::App#Paragraphs (method)">#Paragraphs</a></span> + + <small>Axlsx::App</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Override.html#PartName-instance_method" title="Axlsx::Override#PartName (method)">#PartName</a></span> + + <small>Axlsx::Override</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/App.html#PresentationFormat-instance_method" title="Axlsx::App#PresentationFormat (method)">#PresentationFormat</a></span> + + <small>Axlsx::App</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/App.html#ScaleCrop-instance_method" title="Axlsx::App#ScaleCrop (method)">#ScaleCrop</a></span> + + <small>Axlsx::App</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/App.html#ShareDoc-instance_method" title="Axlsx::App#ShareDoc (method)">#ShareDoc</a></span> + + <small>Axlsx::App</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/App.html#Slides-instance_method" title="Axlsx::App#Slides (method)">#Slides</a></span> + + <small>Axlsx::App</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Relationship.html#Target-instance_method" title="Axlsx::Relationship#Target (method)">#Target</a></span> + + <small>Axlsx::Relationship</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/App.html#Template-instance_method" title="Axlsx::App#Template (method)">#Template</a></span> + + <small>Axlsx::App</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/App.html#TotalTime-instance_method" title="Axlsx::App#TotalTime (method)">#TotalTime</a></span> + + <small>Axlsx::App</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Relationship.html#Type-instance_method" title="Axlsx::Relationship#Type (method)">#Type</a></span> + + <small>Axlsx::Relationship</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/App.html#Words-instance_method" title="Axlsx::App#Words (method)">#Words</a></span> + + <small>Axlsx::App</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/SimpleTypedList.html#%5B%5D%3D-instance_method" title="Axlsx::SimpleTypedList#[]= (method)">#[]=</a></span> + + <small>Axlsx::SimpleTypedList</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Row.html#add_cell-instance_method" title="Axlsx::Row#add_cell (method)">#add_cell</a></span> + + <small>Axlsx::Row</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Worksheet.html#add_chart-instance_method" title="Axlsx::Worksheet#add_chart (method)">#add_chart</a></span> + + <small>Axlsx::Worksheet</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Drawing.html#add_chart-instance_method" title="Axlsx::Drawing#add_chart (method)">#add_chart</a></span> + + <small>Axlsx::Drawing</small> + + </li> + + + <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> + + </li> + + + <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> + + </li> + + + <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> + + </li> + + + <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> + + </li> + + + <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> + + </li> + + + <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> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Drawing.html#anchors-instance_method" title="Axlsx::Drawing#anchors (method)">#anchors</a></span> + + <small>Axlsx::Drawing</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Xf.html#applyAlignment-instance_method" title="Axlsx::Xf#applyAlignment (method)">#applyAlignment</a></span> + + <small>Axlsx::Xf</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Xf.html#applyBorder-instance_method" title="Axlsx::Xf#applyBorder (method)">#applyBorder</a></span> + + <small>Axlsx::Xf</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Xf.html#applyFill-instance_method" title="Axlsx::Xf#applyFill (method)">#applyFill</a></span> + + <small>Axlsx::Xf</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Xf.html#applyFont-instance_method" title="Axlsx::Xf#applyFont (method)">#applyFont</a></span> + + <small>Axlsx::Xf</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Xf.html#applyNumberFormat-instance_method" title="Axlsx::Xf#applyNumberFormat (method)">#applyNumberFormat</a></span> + + <small>Axlsx::Xf</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Xf.html#applyProtection-instance_method" title="Axlsx::Xf#applyProtection (method)">#applyProtection</a></span> + + <small>Axlsx::Xf</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Color.html#auto-instance_method" title="Axlsx::Color#auto (method)">#auto</a></span> + + <small>Axlsx::Color</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/CatAxis.html#auto-instance_method" title="Axlsx::CatAxis#auto (method)">#auto</a></span> + + <small>Axlsx::CatAxis</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Worksheet.html#auto_fit_data-instance_method" title="Axlsx::Worksheet#auto_fit_data (method)">#auto_fit_data</a></span> + + <small>Axlsx::Worksheet</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Worksheet.html#auto_width-instance_method" title="Axlsx::Worksheet#auto_width (method)">#auto_width</a></span> + + <small>Axlsx::Worksheet</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Axis.html#axId-instance_method" title="Axlsx::Axis#axId (method)">#axId</a></span> + + <small>Axlsx::Axis</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Axis.html#axPos-instance_method" title="Axlsx::Axis#axPos (method)">#axPos</a></span> + + <small>Axlsx::Axis</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Font.html#b-instance_method" title="Axlsx::Font#b (method)">#b</a></span> + + <small>Axlsx::Font</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Bar3DChart.html#barDir-instance_method" title="Axlsx::Bar3DChart#barDir (method)">#barDir</a></span> + + <small>Axlsx::Bar3DChart</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Package.html#base_content_types-instance_method" title="Axlsx::Package#base_content_types (method)">#base_content_types</a></span> + + <small>Axlsx::Package</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/PatternFill.html#bgColor-instance_method" title="Axlsx::PatternFill#bgColor (method)">#bgColor</a></span> + + <small>Axlsx::PatternFill</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Xf.html#borderId-instance_method" title="Axlsx::Xf#borderId (method)">#borderId</a></span> + + <small>Axlsx::Xf</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Styles.html#borders-instance_method" title="Axlsx::Styles#borders (method)">#borders</a></span> + + <small>Axlsx::Styles</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/GradientFill.html#bottom-instance_method" title="Axlsx::GradientFill#bottom (method)">#bottom</a></span> + + <small>Axlsx::GradientFill</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/CellStyle.html#builtinId-instance_method" title="Axlsx::CellStyle#builtinId (method)">#builtinId</a></span> + + <small>Axlsx::CellStyle</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Cell.html#cast_value-instance_method" title="Axlsx::Cell#cast_value (method)">#cast_value</a></span> + + <small>Axlsx::Cell</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Bar3DChart.html#catAxis-instance_method" title="Axlsx::Bar3DChart#catAxis (method)">#catAxis</a></span> + + <small>Axlsx::Bar3DChart</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Title.html#cell-instance_method" title="Axlsx::Title#cell (method)">#cell</a></span> + + <small>Axlsx::Title</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Styles.html#cellStyleXfs-instance_method" title="Axlsx::Styles#cellStyleXfs (method)">#cellStyleXfs</a></span> + + <small>Axlsx::Styles</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Styles.html#cellStyles-instance_method" title="Axlsx::Styles#cellStyles (method)">#cellStyles</a></span> + + <small>Axlsx::Styles</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Styles.html#cellXfs-instance_method" title="Axlsx::Styles#cellXfs (method)">#cellXfs</a></span> + + <small>Axlsx::Styles</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx.html#cell_range-class_method" title="Axlsx.cell_range (method)">cell_range</a></span> + + <small>Axlsx</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Cell.html#cell_type_from_value-instance_method" title="Axlsx::Cell#cell_type_from_value (method)">#cell_type_from_value</a></span> + + <small>Axlsx::Cell</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Row.html#cells-instance_method" title="Axlsx::Row#cells (method)">#cells</a></span> + + <small>Axlsx::Row</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Font.html#charset-instance_method" title="Axlsx::Font#charset (method)">#charset</a></span> + + <small>Axlsx::Font</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/GraphicFrame.html#chart-instance_method" title="Axlsx::GraphicFrame#chart (method)">#chart</a></span> + + <small>Axlsx::GraphicFrame</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Series.html#chart-instance_method" title="Axlsx::Series#chart (method)">#chart</a></span> + + <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> + + <small>Axlsx::Workbook</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> + + <small>Axlsx::Drawing</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Marker.html#col-instance_method" title="Axlsx::Marker#col (method)">#col</a></span> + + <small>Axlsx::Marker</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Marker.html#colOff-instance_method" title="Axlsx::Marker#colOff (method)">#colOff</a></span> + + <small>Axlsx::Marker</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Cell.html#col_ref-instance_method" title="Axlsx::Cell#col_ref (method)">#col_ref</a></span> + + <small>Axlsx::Cell</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Font.html#color-instance_method" title="Axlsx::Font#color (method)">#color</a></span> + + <small>Axlsx::Font</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/BorderPr.html#color-instance_method" title="Axlsx::BorderPr#color (method)">#color</a></span> + + <small>Axlsx::BorderPr</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/GradientStop.html#color-instance_method" title="Axlsx::GradientStop#color (method)">#color</a></span> + + <small>Axlsx::GradientStop</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Font.html#condense-instance_method" title="Axlsx::Font#condense (method)">#condense</a></span> + + <small>Axlsx::Font</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Package.html#content_types-instance_method" title="Axlsx::Package#content_types (method)">#content_types</a></span> + + <small>Axlsx::Package</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Marker.html#coord-instance_method" title="Axlsx::Marker#coord (method)">#coord</a></span> + + <small>Axlsx::Marker</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Core.html#creator-instance_method" title="Axlsx::Core#creator (method)">#creator</a></span> + + <small>Axlsx::Core</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Axis.html#crossAx-instance_method" title="Axlsx::Axis#crossAx (method)">#crossAx</a></span> + + <small>Axlsx::Axis</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/ValAxis.html#crossBetween-instance_method" title="Axlsx::ValAxis#crossBetween (method)">#crossBetween</a></span> + + <small>Axlsx::ValAxis</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Axis.html#crosses-instance_method" title="Axlsx::Axis#crosses (method)">#crosses</a></span> + + <small>Axlsx::Axis</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/CellStyle.html#customBuiltin-instance_method" title="Axlsx::CellStyle#customBuiltin (method)">#customBuiltin</a></span> + + <small>Axlsx::CellStyle</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/PieSeries.html#data-instance_method" title="Axlsx::PieSeries#data (method)">#data</a></span> + + <small>Axlsx::PieSeries</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> + + <small>Axlsx::BarSeries</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Workbook.html#date1904-instance_method" title="Axlsx::Workbook#date1904 (method)">#date1904</a></span> + + <small>Axlsx::Workbook</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> + + <small>Axlsx::Workbook</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Workbook.html#date1904%3D-class_method" title="Axlsx::Workbook.date1904= (method)">date1904=</a></span> + + <small>Axlsx::Workbook</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/TableStyles.html#defaultPivotStyle-instance_method" title="Axlsx::TableStyles#defaultPivotStyle (method)">#defaultPivotStyle</a></span> + + <small>Axlsx::TableStyles</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/TableStyles.html#defaultTableStyle-instance_method" title="Axlsx::TableStyles#defaultTableStyle (method)">#defaultTableStyle</a></span> + + <small>Axlsx::TableStyles</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/GradientFill.html#degree-instance_method" title="Axlsx::GradientFill#degree (method)">#degree</a></span> + + <small>Axlsx::GradientFill</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/SimpleTypedList.html#delete-instance_method" title="Axlsx::SimpleTypedList#delete (method)">#delete</a></span> + + <small>Axlsx::SimpleTypedList</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/SimpleTypedList.html#delete_at-instance_method" title="Axlsx::SimpleTypedList#delete_at (method)">#delete_at</a></span> + + <small>Axlsx::SimpleTypedList</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/View3D.html#depthPercent-instance_method" title="Axlsx::View3D#depthPercent (method)">#depthPercent</a></span> + + <small>Axlsx::View3D</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> + + </li> + + + <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> + + </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> + + <small>Axlsx::Worksheet</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Workbook.html#drawings-instance_method" title="Axlsx::Workbook#drawings (method)">#drawings</a></span> + + <small>Axlsx::Workbook</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/TableStyleElement.html#dxfId-instance_method" title="Axlsx::TableStyleElement#dxfId (method)">#dxfId</a></span> + + <small>Axlsx::TableStyleElement</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Styles.html#dxfs-instance_method" title="Axlsx::Styles#dxfs (method)">#dxfs</a></span> + + <small>Axlsx::Styles</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/TwoCellAnchor.html#end_at-instance_method" title="Axlsx::TwoCellAnchor#end_at (method)">#end_at</a></span> + + <small>Axlsx::TwoCellAnchor</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Chart.html#end_at-instance_method" title="Axlsx::Chart#end_at (method)">#end_at</a></span> + + <small>Axlsx::Chart</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/PieSeries.html#explosion-instance_method" title="Axlsx::PieSeries#explosion (method)">#explosion</a></span> + + <small>Axlsx::PieSeries</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Font.html#extend-instance_method" title="Axlsx::Font#extend (method)">#extend</a></span> + + <small>Axlsx::Font</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Font.html#family-instance_method" title="Axlsx::Font#family (method)">#family</a></span> + + <small>Axlsx::Font</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/PatternFill.html#fgColor-instance_method" title="Axlsx::PatternFill#fgColor (method)">#fgColor</a></span> + + <small>Axlsx::PatternFill</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> + + <small>Axlsx::Xf</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Fill.html#fill_type-instance_method" title="Axlsx::Fill#fill_type (method)">#fill_type</a></span> + + <small>Axlsx::Fill</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Styles.html#fills-instance_method" title="Axlsx::Styles#fills (method)">#fills</a></span> + + <small>Axlsx::Styles</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Xf.html#fontId-instance_method" title="Axlsx::Xf#fontId (method)">#fontId</a></span> + + <small>Axlsx::Xf</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Styles.html#fonts-instance_method" title="Axlsx::Styles#fonts (method)">#fonts</a></span> + + <small>Axlsx::Styles</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/NumFmt.html#formatCode-instance_method" title="Axlsx::NumFmt#formatCode (method)">#formatCode</a></span> + + <small>Axlsx::NumFmt</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Axis.html#format_code-instance_method" title="Axlsx::Axis#format_code (method)">#format_code</a></span> + + <small>Axlsx::Axis</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/TwoCellAnchor.html#from-instance_method" title="Axlsx::TwoCellAnchor#from (method)">#from</a></span> + + <small>Axlsx::TwoCellAnchor</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> + + <small>Axlsx::Bar3DChart</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> + + <small>Axlsx::Bar3DChart</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/TwoCellAnchor.html#graphic_frame-instance_method" title="Axlsx::TwoCellAnchor#graphic_frame (method)">#graphic_frame</a></span> + + <small>Axlsx::TwoCellAnchor</small> + + </li> + + + <li class="r2 "> + <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::Chart</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Bar3DChart.html#grouping-instance_method" title="Axlsx::Bar3DChart#grouping (method)">#grouping</a></span> + + <small>Axlsx::Bar3DChart</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/View3D.html#hPercent-instance_method" title="Axlsx::View3D#hPercent (method)">#hPercent</a></span> + + <small>Axlsx::View3D</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/CellStyle.html#hidden-instance_method" title="Axlsx::CellStyle#hidden (method)">#hidden</a></span> + + <small>Axlsx::CellStyle</small> + + </li> + + + <li class="r2 "> + <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="r1 "> + <span class='object_link'><a href="Axlsx/CellAlignment.html#horizontal-instance_method" title="Axlsx::CellAlignment#horizontal (method)">#horizontal</a></span> + + <small>Axlsx::CellAlignment</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Font.html#i-instance_method" title="Axlsx::Font#i (method)">#i</a></span> + + <small>Axlsx::Font</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/CellStyle.html#iLevel-instance_method" title="Axlsx::CellStyle#iLevel (method)">#iLevel</a></span> + + <small>Axlsx::CellStyle</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/CellAlignment.html#indent-instance_method" title="Axlsx::CellAlignment#indent (method)">#indent</a></span> + + <small>Axlsx::CellAlignment</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Chart.html#index-instance_method" title="Axlsx::Chart#index (method)">#index</a></span> + + <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> + + <small>Axlsx::Worksheet</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Row.html#index-instance_method" title="Axlsx::Row#index (method)">#index</a></span> + + <small>Axlsx::Row</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Series.html#index-instance_method" title="Axlsx::Series#index (method)">#index</a></span> + + <small>Axlsx::Series</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Cell.html#index-instance_method" title="Axlsx::Cell#index (method)">#index</a></span> + + <small>Axlsx::Cell</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Drawing.html#index-instance_method" title="Axlsx::Drawing#index (method)">#index</a></span> + + <small>Axlsx::Drawing</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/TwoCellAnchor.html#index-instance_method" title="Axlsx::TwoCellAnchor#index (method)">#index</a></span> + + <small>Axlsx::TwoCellAnchor</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/App.html#initalize-instance_method" title="Axlsx::App#initalize (method)">#initalize</a></span> + + <small>Axlsx::App</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> + + <small>Axlsx::Worksheet</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> + + <small>Axlsx::Relationship</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> + + <small>Axlsx::CellStyle</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Workbook.html#initialize-instance_method" title="Axlsx::Workbook#initialize (method)">#initialize</a></span> + + <small>Axlsx::Workbook</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Border.html#initialize-instance_method" title="Axlsx::Border#initialize (method)">#initialize</a></span> + + <small>Axlsx::Border</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> + + <small>Axlsx::Relationships</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Drawing.html#initialize-instance_method" title="Axlsx::Drawing#initialize (method)">#initialize</a></span> + + <small>Axlsx::Drawing</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Pie3DChart.html#initialize-instance_method" title="Axlsx::Pie3DChart#initialize (method)">#initialize</a></span> + + <small>Axlsx::Pie3DChart</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/BorderPr.html#initialize-instance_method" title="Axlsx::BorderPr#initialize (method)">#initialize</a></span> + + <small>Axlsx::BorderPr</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/SimpleTypedList.html#initialize-instance_method" title="Axlsx::SimpleTypedList#initialize (method)">#initialize</a></span> + + <small>Axlsx::SimpleTypedList</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Bar3DChart.html#initialize-instance_method" title="Axlsx::Bar3DChart#initialize (method)">#initialize</a></span> + + <small>Axlsx::Bar3DChart</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Core.html#initialize-instance_method" title="Axlsx::Core#initialize (method)">#initialize</a></span> + + <small>Axlsx::Core</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Title.html#initialize-instance_method" title="Axlsx::Title#initialize (method)">#initialize</a></span> + + <small>Axlsx::Title</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> + + <small>Axlsx::BarSeries</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/GradientStop.html#initialize-instance_method" title="Axlsx::GradientStop#initialize (method)">#initialize</a></span> + + <small>Axlsx::GradientStop</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Chart.html#initialize-instance_method" title="Axlsx::Chart#initialize (method)">#initialize</a></span> + + <small>Axlsx::Chart</small> + + </li> + + + <li class="r1 "> + <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="r2 "> + <span class='object_link'><a href="Axlsx/NumFmt.html#initialize-instance_method" title="Axlsx::NumFmt#initialize (method)">#initialize</a></span> + + <small>Axlsx::NumFmt</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Cell.html#initialize-instance_method" title="Axlsx::Cell#initialize (method)">#initialize</a></span> + + <small>Axlsx::Cell</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> + + <small>Axlsx::GraphicFrame</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/TableStyle.html#initialize-instance_method" title="Axlsx::TableStyle#initialize (method)">#initialize</a></span> + + <small>Axlsx::TableStyle</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Fill.html#initialize-instance_method" title="Axlsx::Fill#initialize (method)">#initialize</a></span> + + <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> + + <small>Axlsx::Font</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> + + <small>Axlsx::PieSeries</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> + + <small>Axlsx::Axis</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> + + <small>Axlsx::TableStyles</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> + + <small>Axlsx::Xf</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/GradientFill.html#initialize-instance_method" title="Axlsx::GradientFill#initialize (method)">#initialize</a></span> + + <small>Axlsx::GradientFill</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> + + <small>Axlsx::CellAlignment</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Default.html#initialize-instance_method" title="Axlsx::Default#initialize (method)">#initialize</a></span> + + <small>Axlsx::Default</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> + + <small>Axlsx::TableStyleElement</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> + + <small>Axlsx::View3D</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> + + <small>Axlsx::Override</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/CatAxis.html#initialize-instance_method" title="Axlsx::CatAxis#initialize (method)">#initialize</a></span> + + <small>Axlsx::CatAxis</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> + + <small>Axlsx::Row</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/PatternFill.html#initialize-instance_method" title="Axlsx::PatternFill#initialize (method)">#initialize</a></span> + + <small>Axlsx::PatternFill</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Package.html#initialize-instance_method" title="Axlsx::Package#initialize (method)">#initialize</a></span> + + <small>Axlsx::Package</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> + + <small>Axlsx::Scaling</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/TwoCellAnchor.html#initialize-instance_method" title="Axlsx::TwoCellAnchor#initialize (method)">#initialize</a></span> + + <small>Axlsx::TwoCellAnchor</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/ContentType.html#initialize-instance_method" title="Axlsx::ContentType#initialize (method)">#initialize</a></span> + + <small>Axlsx::ContentType</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> + + <small>Axlsx::ValAxis</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Series.html#initialize-instance_method" title="Axlsx::Series#initialize (method)">#initialize</a></span> + + <small>Axlsx::Series</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Marker.html#initialize-instance_method" title="Axlsx::Marker#initialize (method)">#initialize</a></span> + + <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> + + <small>Axlsx::CellProtection</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Styles.html#initialize-instance_method" title="Axlsx::Styles#initialize (method)">#initialize</a></span> + + <small>Axlsx::Styles</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/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/PieSeries.html#labels-instance_method" title="Axlsx::PieSeries#labels (method)">#labels</a></span> + + <small>Axlsx::PieSeries</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/CatAxis.html#lblAlgn-instance_method" title="Axlsx::CatAxis#lblAlgn (method)">#lblAlgn</a></span> + + <small>Axlsx::CatAxis</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/CatAxis.html#lblOffset-instance_method" title="Axlsx::CatAxis#lblOffset (method)">#lblOffset</a></span> + + <small>Axlsx::CatAxis</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/GradientFill.html#left-instance_method" title="Axlsx::GradientFill#left (method)">#left</a></span> + + <small>Axlsx::GradientFill</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/SimpleTypedList.html#lock-instance_method" title="Axlsx::SimpleTypedList#lock (method)">#lock</a></span> + + <small>Axlsx::SimpleTypedList</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/CellProtection.html#locked-instance_method" title="Axlsx::CellProtection#locked (method)">#locked</a></span> + + <small>Axlsx::CellProtection</small> + + </li> + + + <li class="r2 "> + <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> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Scaling.html#logBase-instance_method" title="Axlsx::Scaling#logBase (method)">#logBase</a></span> + + <small>Axlsx::Scaling</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Scaling.html#max-instance_method" title="Axlsx::Scaling#max (method)">#max</a></span> + + <small>Axlsx::Scaling</small> + + </li> + + + <li class="r1 "> + <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> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Scaling.html#min-instance_method" title="Axlsx::Scaling#min (method)">#min</a></span> + + <small>Axlsx::Scaling</small> + + </li> + + + <li class="r1 "> + <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="r2 "> + <span class='object_link'><a href="Axlsx/CellStyle.html#name-instance_method" title="Axlsx::CellStyle#name (method)">#name</a></span> + + <small>Axlsx::CellStyle</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/TableStyle.html#name-instance_method" title="Axlsx::TableStyle#name (method)">#name</a></span> + + <small>Axlsx::TableStyle</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/BorderPr.html#name-instance_method" title="Axlsx::BorderPr#name (method)">#name</a></span> + + <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> + + <small>Axlsx::Font</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/NumFmt.html#numFmtId-instance_method" title="Axlsx::NumFmt#numFmtId (method)">#numFmtId</a></span> + + <small>Axlsx::NumFmt</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Xf.html#numFmtId-instance_method" title="Axlsx::Xf#numFmtId (method)">#numFmtId</a></span> + + <small>Axlsx::Xf</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Styles.html#numFmts-instance_method" title="Axlsx::Styles#numFmts (method)">#numFmts</a></span> + + <small>Axlsx::Styles</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> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Scaling.html#orientation-instance_method" title="Axlsx::Scaling#orientation (method)">#orientation</a></span> + + <small>Axlsx::Scaling</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Border.html#outline-instance_method" title="Axlsx::Border#outline (method)">#outline</a></span> + + <small>Axlsx::Border</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> + + <small>Axlsx::Font</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Package.html#parts-instance_method" title="Axlsx::Package#parts (method)">#parts</a></span> + + <small>Axlsx::Package</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/PatternFill.html#patternType-instance_method" title="Axlsx::PatternFill#patternType (method)">#patternType</a></span> + + <small>Axlsx::PatternFill</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/View3D.html#perspective-instance_method" title="Axlsx::View3D#perspective (method)">#perspective</a></span> + + <small>Axlsx::View3D</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/TableStyle.html#pivot-instance_method" title="Axlsx::TableStyle#pivot (method)">#pivot</a></span> + + <small>Axlsx::TableStyle</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Xf.html#pivotButton-instance_method" title="Axlsx::Xf#pivotButton (method)">#pivotButton</a></span> + + <small>Axlsx::Xf</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Chart.html#pn-instance_method" title="Axlsx::Chart#pn (method)">#pn</a></span> + + <small>Axlsx::Chart</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> + + <small>Axlsx::Drawing</small> + + </li> + + + <li class="r2 "> + <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="r1 "> + <span class='object_link'><a href="Axlsx/GradientStop.html#position-instance_method" title="Axlsx::GradientStop#position (method)">#position</a></span> + + <small>Axlsx::GradientStop</small> + + </li> + + + <li class="r2 "> + <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> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Xf.html#protection-instance_method" title="Axlsx::Xf#protection (method)">#protection</a></span> + + <small>Axlsx::Xf</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Border.html#prs-instance_method" title="Axlsx::Border#prs (method)">#prs</a></span> + + <small>Axlsx::Border</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/SimpleTypedList.html#push-instance_method" title="Axlsx::SimpleTypedList#push (method)">#push</a></span> + + <small>Axlsx::SimpleTypedList</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Xf.html#quotePrefix-instance_method" title="Axlsx::Xf#quotePrefix (method)">#quotePrefix</a></span> + + <small>Axlsx::Xf</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Cell.html#r-instance_method" title="Axlsx::Cell#r (method)">#r</a></span> + + <small>Axlsx::Cell</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/View3D.html#rAngAx-instance_method" title="Axlsx::View3D#rAngAx (method)">#rAngAx</a></span> + + <small>Axlsx::View3D</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Worksheet.html#rId-instance_method" title="Axlsx::Worksheet#rId (method)">#rId</a></span> + + <small>Axlsx::Worksheet</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/GraphicFrame.html#rId-instance_method" title="Axlsx::GraphicFrame#rId (method)">#rId</a></span> + + <small>Axlsx::GraphicFrame</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Drawing.html#rId-instance_method" title="Axlsx::Drawing#rId (method)">#rId</a></span> + + <small>Axlsx::Drawing</small> + + </li> + + + <li class="r2 "> + <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> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Title.html#range-instance_method" title="Axlsx::Title#range (method)">#range</a></span> + + <small>Axlsx::Title</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/CellAlignment.html#readingOrder-instance_method" title="Axlsx::CellAlignment#readingOrder (method)">#readingOrder</a></span> + + <small>Axlsx::CellAlignment</small> + + </li> + + + <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::Package</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Drawing.html#relationships-instance_method" title="Axlsx::Drawing#relationships (method)">#relationships</a></span> + + <small>Axlsx::Drawing</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Worksheet.html#relationships-instance_method" title="Axlsx::Worksheet#relationships (method)">#relationships</a></span> + + <small>Axlsx::Worksheet</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Workbook.html#relationships-instance_method" title="Axlsx::Workbook#relationships (method)">#relationships</a></span> + + <small>Axlsx::Workbook</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/CellAlignment.html#relativeIndent-instance_method" title="Axlsx::CellAlignment#relativeIndent (method)">#relativeIndent</a></span> + + <small>Axlsx::CellAlignment</small> + + </li> + + + <li class="r2 "> + <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::Worksheet</small> + + </li> + + + <li class="r1 "> + <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::Drawing</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Color.html#rgb-instance_method" title="Axlsx::Color#rgb (method)">#rgb</a></span> + + <small>Axlsx::Color</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/GradientFill.html#right-instance_method" title="Axlsx::GradientFill#right (method)">#right</a></span> + + <small>Axlsx::GradientFill</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/View3D.html#rotX-instance_method" title="Axlsx::View3D#rotX (method)">#rotX</a></span> + + <small>Axlsx::View3D</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/View3D.html#rotY-instance_method" title="Axlsx::View3D#rotY (method)">#rotY</a></span> + + <small>Axlsx::View3D</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Cell.html#row-instance_method" title="Axlsx::Cell#row (method)">#row</a></span> + + <small>Axlsx::Cell</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Marker.html#row-instance_method" title="Axlsx::Marker#row (method)">#row</a></span> + + <small>Axlsx::Marker</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Marker.html#rowOff-instance_method" title="Axlsx::Marker#rowOff (method)">#rowOff</a></span> + + <small>Axlsx::Marker</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Worksheet.html#rows-instance_method" title="Axlsx::Worksheet#rows (method)">#rows</a></span> + + <small>Axlsx::Worksheet</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Axis.html#scaling-instance_method" title="Axlsx::Axis#scaling (method)">#scaling</a></span> + + <small>Axlsx::Axis</small> + + </li> + + + <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> + + </li> + + + <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> + + </li> + + + <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> + + </li> + + + <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> + + </li> + + + <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> + + </li> + + + <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> + + </li> + + + <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> + + </li> + + + <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> + + </li> + + + <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> + + </li> + + + <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> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/TwoCellAnchor.html#start_at-instance_method" title="Axlsx::TwoCellAnchor#start_at (method)">#start_at</a></span> + + <small>Axlsx::TwoCellAnchor</small> + + </li> + + + <li class="r2 "> + <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> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/GradientFill.html#stop-instance_method" title="Axlsx::GradientFill#stop (method)">#stop</a></span> + + <small>Axlsx::GradientFill</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Font.html#strike-instance_method" title="Axlsx::Font#strike (method)">#strike</a></span> + + <small>Axlsx::Font</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/BorderPr.html#style-instance_method" title="Axlsx::BorderPr#style (method)">#style</a></span> + + <small>Axlsx::BorderPr</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> + + <small>Axlsx::Cell</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Workbook.html#styles-instance_method" title="Axlsx::Workbook#styles (method)">#styles</a></span> + + <small>Axlsx::Workbook</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Font.html#sz-instance_method" title="Axlsx::Font#sz (method)">#sz</a></span> + + <small>Axlsx::Font</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/TableStyle.html#table-instance_method" title="Axlsx::TableStyle#table (method)">#table</a></span> + + <small>Axlsx::TableStyle</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Styles.html#tableStyles-instance_method" title="Axlsx::Styles#tableStyles (method)">#tableStyles</a></span> + + <small>Axlsx::Styles</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Title.html#text-instance_method" title="Axlsx::Title#text (method)">#text</a></span> + + <small>Axlsx::Title</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/CellAlignment.html#textRotation-instance_method" title="Axlsx::CellAlignment#textRotation (method)">#textRotation</a></span> + + <small>Axlsx::CellAlignment</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Axis.html#tickLblPos-instance_method" title="Axlsx::Axis#tickLblPos (method)">#tickLblPos</a></span> + + <small>Axlsx::Axis</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Color.html#tint-instance_method" title="Axlsx::Color#tint (method)">#tint</a></span> + + <small>Axlsx::Color</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Chart.html#title-instance_method" title="Axlsx::Chart#title (method)">#title</a></span> + + <small>Axlsx::Chart</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Series.html#title-instance_method" title="Axlsx::Series#title (method)">#title</a></span> + + <small>Axlsx::Series</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> + + <small>Axlsx::TwoCellAnchor</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/BarSeries.html#to_xml-instance_method" title="Axlsx::BarSeries#to_xml (method)">#to_xml</a></span> + + <small>Axlsx::BarSeries</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Row.html#to_xml-instance_method" title="Axlsx::Row#to_xml (method)">#to_xml</a></span> + + <small>Axlsx::Row</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Override.html#to_xml-instance_method" title="Axlsx::Override#to_xml (method)">#to_xml</a></span> + + <small>Axlsx::Override</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/TableStyle.html#to_xml-instance_method" title="Axlsx::TableStyle#to_xml (method)">#to_xml</a></span> + + <small>Axlsx::TableStyle</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> + + <small>Axlsx::GradientStop</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> + + <small>Axlsx::Axis</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> + + <small>Axlsx::Border</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> + + <small>Axlsx::Worksheet</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Font.html#to_xml-instance_method" title="Axlsx::Font#to_xml (method)">#to_xml</a></span> + + <small>Axlsx::Font</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> + + <small>Axlsx::Cell</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> + + <small>Axlsx::PatternFill</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> + + <small>Axlsx::GradientFill</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Default.html#to_xml-instance_method" title="Axlsx::Default#to_xml (method)">#to_xml</a></span> + + <small>Axlsx::Default</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/CellAlignment.html#to_xml-instance_method" title="Axlsx::CellAlignment#to_xml (method)">#to_xml</a></span> + + <small>Axlsx::CellAlignment</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/CellStyle.html#to_xml-instance_method" title="Axlsx::CellStyle#to_xml (method)">#to_xml</a></span> + + <small>Axlsx::CellStyle</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> + + <small>Axlsx::Core</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> + + <small>Axlsx::Title</small> + + </li> + + + <li class="r1 "> + <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::Fill</small> + + </li> + + + <li class="r2 "> + <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::Scaling</small> + + </li> + + + <li class="r1 "> + <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::TableStyles</small> + + </li> + + + <li class="r2 "> + <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::Workbook</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/TwoCellAnchor.html#to_xml-instance_method" title="Axlsx::TwoCellAnchor#to_xml (method)">#to_xml</a></span> + + <small>Axlsx::TwoCellAnchor</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> + + <small>Axlsx::Xf</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/GraphicFrame.html#to_xml-instance_method" title="Axlsx::GraphicFrame#to_xml (method)">#to_xml</a></span> + + <small>Axlsx::GraphicFrame</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> + + <small>Axlsx::View3D</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Pie3DChart.html#to_xml-instance_method" title="Axlsx::Pie3DChart#to_xml (method)">#to_xml</a></span> + + <small>Axlsx::Pie3DChart</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/CatAxis.html#to_xml-instance_method" title="Axlsx::CatAxis#to_xml (method)">#to_xml</a></span> + + <small>Axlsx::CatAxis</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> + + <small>Axlsx::TableStyleElement</small> + + </li> + + + <li class="r2 "> + <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::Drawing</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/App.html#to_xml-instance_method" title="Axlsx::App#to_xml (method)">#to_xml</a></span> + + <small>Axlsx::App</small> + + </li> + + + <li class="r2 "> + <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::Marker</small> + + </li> + + + <li class="r1 "> + <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::Relationship</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> + + <small>Axlsx::PieSeries</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/SimpleTypedList.html#to_xml-instance_method" title="Axlsx::SimpleTypedList#to_xml (method)">#to_xml</a></span> + + <small>Axlsx::SimpleTypedList</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> + + <small>Axlsx::Chart</small> + + </li> + + + <li class="r2 "> + <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::Relationships</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> + + <small>Axlsx::Styles</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> + + <small>Axlsx::BorderPr</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/ValAxis.html#to_xml-instance_method" title="Axlsx::ValAxis#to_xml (method)">#to_xml</a></span> + + <small>Axlsx::ValAxis</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/CellProtection.html#to_xml-instance_method" title="Axlsx::CellProtection#to_xml (method)">#to_xml</a></span> + + <small>Axlsx::CellProtection</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> + + <small>Axlsx::NumFmt</small> + + </li> + + + <li class="r2 "> + <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::ContentType</small> + + </li> + + + <li class="r1 "> + <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::Color</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> + + <small>Axlsx::Series</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/GradientFill.html#top-instance_method" title="Axlsx::GradientFill#top (method)">#top</a></span> + + <small>Axlsx::GradientFill</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/TableStyleElement.html#type-instance_method" title="Axlsx::TableStyleElement#type (method)">#type</a></span> + + <small>Axlsx::TableStyleElement</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/GradientFill.html#type-instance_method" title="Axlsx::GradientFill#type (method)">#type</a></span> + + <small>Axlsx::GradientFill</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Cell.html#type-instance_method" title="Axlsx::Cell#type (method)">#type</a></span> + + <small>Axlsx::Cell</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/SimpleTypedList.html#unlock-instance_method" title="Axlsx::SimpleTypedList#unlock (method)">#unlock</a></span> + + <small>Axlsx::SimpleTypedList</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Worksheet.html#update_auto_fit_data-instance_method" title="Axlsx::Worksheet#update_auto_fit_data (method)">#update_auto_fit_data</a></span> + + <small>Axlsx::Worksheet</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Bar3DChart.html#valAxis-instance_method" title="Axlsx::Bar3DChart#valAxis (method)">#valAxis</a></span> + + <small>Axlsx::Bar3DChart</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/RegexValidator.html#validate-class_method" title="Axlsx::RegexValidator.validate (method)">validate</a></span> + + <small>Axlsx::RegexValidator</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Package.html#validate-instance_method" title="Axlsx::Package#validate (method)">#validate</a></span> + + <small>Axlsx::Package</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> + + <small>Axlsx::DataTypeValidator</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/RestrictionValidator.html#validate-class_method" title="Axlsx::RestrictionValidator.validate (method)">validate</a></span> + + <small>Axlsx::RestrictionValidator</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx.html#validate_boolean-class_method" title="Axlsx.validate_boolean (method)">validate_boolean</a></span> + + <small>Axlsx</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx.html#validate_content_type-class_method" title="Axlsx.validate_content_type (method)">validate_content_type</a></span> + + <small>Axlsx</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx.html#validate_float-class_method" title="Axlsx.validate_float (method)">validate_float</a></span> + + <small>Axlsx</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx.html#validate_gradient_type-class_method" title="Axlsx.validate_gradient_type (method)">validate_gradient_type</a></span> + + <small>Axlsx</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx.html#validate_horizontal_alignment-class_method" title="Axlsx.validate_horizontal_alignment (method)">validate_horizontal_alignment</a></span> + + <small>Axlsx</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx.html#validate_int-class_method" title="Axlsx.validate_int (method)">validate_int</a></span> + + <small>Axlsx</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx.html#validate_pattern_type-class_method" title="Axlsx.validate_pattern_type (method)">validate_pattern_type</a></span> + + <small>Axlsx</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx.html#validate_relationship_type-class_method" title="Axlsx.validate_relationship_type (method)">validate_relationship_type</a></span> + + <small>Axlsx</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Package.html#validate_single_doc-instance_method" title="Axlsx::Package#validate_single_doc (method)">#validate_single_doc</a></span> + + <small>Axlsx::Package</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx.html#validate_string-class_method" title="Axlsx.validate_string (method)">validate_string</a></span> + + <small>Axlsx</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx.html#validate_table_element_type-class_method" title="Axlsx.validate_table_element_type (method)">validate_table_element_type</a></span> + + <small>Axlsx</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx.html#validate_unsigned_int-class_method" title="Axlsx.validate_unsigned_int (method)">validate_unsigned_int</a></span> + + <small>Axlsx</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx.html#validate_vertical_alignment-class_method" title="Axlsx.validate_vertical_alignment (method)">validate_vertical_alignment</a></span> + + <small>Axlsx</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Cell.html#value-instance_method" title="Axlsx::Cell#value (method)">#value</a></span> + + <small>Axlsx::Cell</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/CellAlignment.html#vertical-instance_method" title="Axlsx::CellAlignment#vertical (method)">#vertical</a></span> + + <small>Axlsx::CellAlignment</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Chart.html#view3D-instance_method" title="Axlsx::Chart#view3D (method)">#view3D</a></span> + + <small>Axlsx::Chart</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/Package.html#workbook-instance_method" title="Axlsx::Package#workbook (method)">#workbook</a></span> + + <small>Axlsx::Package</small> + + </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/Drawing.html#worksheet-instance_method" title="Axlsx::Drawing#worksheet (method)">#worksheet</a></span> + + <small>Axlsx::Drawing</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/Workbook.html#worksheets-instance_method" title="Axlsx::Workbook#worksheets (method)">#worksheets</a></span> + + <small>Axlsx::Workbook</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/CellAlignment.html#wrapText-instance_method" title="Axlsx::CellAlignment#wrapText (method)">#wrapText</a></span> + + <small>Axlsx::CellAlignment</small> + + </li> + + + <li class="r2 "> + <span class='object_link'><a href="Axlsx/CellStyle.html#xfId-instance_method" title="Axlsx::CellStyle#xfId (method)">#xfId</a></span> + + <small>Axlsx::CellStyle</small> + + </li> + + + <li class="r1 "> + <span class='object_link'><a href="Axlsx/Xf.html#xfId-instance_method" title="Axlsx::Xf#xfId (method)">#xfId</a></span> + + <small>Axlsx::Xf</small> + + </li> + + + </ul> + </div> + </body> +</html> diff --git a/doc/top-level-namespace.html b/doc/top-level-namespace.html new file mode 100644 index 00000000..dcfde08b --- /dev/null +++ b/doc/top-level-namespace.html @@ -0,0 +1,103 @@ +<!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> + Top Level Namespace + + — 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</a> » + + + <span class="title">Top Level Namespace</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>Top Level Namespace + + + +</h1> + +<dl class="box"> + + + + + + + + +</dl> +<div class="clear"></div> + +<h2>Defined Under Namespace</h2> +<p class="children"> + + + <strong class="modules">Modules:</strong> <span class='object_link'><a href="Axlsx.html" title="Axlsx (module)">Axlsx</a></span> + + + + +</p> + + + + + + + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:44:06 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 |