diff options
Diffstat (limited to 'doc/Axlsx.html')
| -rw-r--r-- | doc/Axlsx.html | 2443 |
1 files changed, 2443 insertions, 0 deletions
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 |