nizongfeng
/
ZZCS
1
0
Rozštěpit 0
Zdrojový kód Úkoly 0 Požadavky na natažení 0 Vydání 0 Wiki Aktivita
Nelze vybrat více než 25 témat Téma musí začínat písmenem nebo číslem, může obsahovat pomlčky („-“) a může být dlouhé až 35 znaků.
2 Revize
1 Větev
14 MiB
 
 
 
 
Strom: 0d86f80fa0
Větve Značky
${ item.name }
Vytvořit větev ${ searchTerm }
z „0d86f80fa0“
${ noResults }
ZZCS/coding/st-xm/ORG/Documentation/API/classes/PHPExcel_Writer_HTML.html

1050 řádky
62 KiB
Surový Blame Historie 

  1. <!DOCTYPE html><html lang="en">

  2. <head>

  3. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

  4. <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">

  5. <meta charset="utf-8">

  6. <title>PHPExcel classes » \PHPExcel_Writer_HTML</title>

  7. <meta name="author" content="Mike van Riel">

  8. <meta name="description" content="">

  9. <link href="../css/template.css" rel="stylesheet" media="all">

  10. <script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">

  11. <link rel="apple-touch-icon" href="../img/apple-touch-icon.png">

  12. <link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">

  13. <link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">

  14. </head>

  15. <body>

  16. <div class="navbar navbar-fixed-top">

  17. <div class="navbar-inner"><div class="container">

  18. <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">PHPExcel classes</a><div class="nav-collapse"><ul class="nav">

  19. <li class="dropdown">

  20. <a href="#api" class="dropdown-toggle" data-toggle="dropdown">

  21.                                     API Documentation <b class="caret"></b></a><ul class="dropdown-menu">

  22. <li><a>Packages</a></li>

  23. <li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>

  24. <li><a href="../packages/JAMA.html"><i class="icon-folder-open"></i> JAMA</a></li>

  25. <li><a href="../packages/JAMA%0D%0ACholesky%20decomposition%20class%0D%0AFor%20a%20symmetric,%20positive%20definite%20matrix%20A,%20the%20Cholesky%20decomposition%0D%0Ais%20an%20lower%20triangular%20matrix%20L%20so%20that%20A%20=%20L*L'.html"><i class="icon-folder-open"></i> JAMA

  26. Cholesky decomposition class

  27. For a symmetric, positive definite matrix A, the Cholesky decomposition

  28. is an lower triangular matrix L so that A = L*L'</a></li>

  29. <li><a href="../packages/JAMA%0D%0AClass%20to%20obtain%20eigenvalues%20and%20eigenvectors%20of%20a%20real%20matrix.html"><i class="icon-folder-open"></i> JAMA

  30. Class to obtain eigenvalues and eigenvectors of a real matrix</a></li>

  31. <li><a href="../packages/JAMA%0D%0AError%20handling.html"><i class="icon-folder-open"></i> JAMA

  32. Error handling</a></li>

  33. <li><a href="../packages/JAMA%0D%0AFor%20an%20m-by-n%20matrix%20A%20with%20m%20&gt;=%20n,%20the%20LU%20decomposition%20is%20an%20m-by-n%0D%0Aunit%20lower%20triangular%20matrix%20L,%20an%20n-by-n%20upper%20triangular%20matrix%20U,%0D%0Aand%20a%20permutation%20vector%20piv%20of%20length%20m%20so%20that%20A(piv,:)%20=%20L*U.html"><i class="icon-folder-open"></i> JAMA

  34. For an m-by-n matrix A with m &gt;= n, the LU decomposition is an m-by-n

  35. unit lower triangular matrix L, an n-by-n upper triangular matrix U,

  36. and a permutation vector piv of length m so that A(piv,:) = L*U</a></li>

  37. <li><a href="../packages/JAMA%0D%0AFor%20an%20m-by-n%20matrix%20A%20with%20m%20&gt;=%20n,%20the%20QR%20decomposition%20is%20an%20m-by-n%0D%0Aorthogonal%20matrix%20Q%20and%20an%20n-by-n%20upper%20triangular%20matrix%20R%20so%20that%0D%0AA%20=%20Q*R.html"><i class="icon-folder-open"></i> JAMA

  38. For an m-by-n matrix A with m &gt;= n, the QR decomposition is an m-by-n

  39. orthogonal matrix Q and an n-by-n upper triangular matrix R so that

  40. A = Q*R</a></li>

  41. <li><a href="../packages/JAMA%0D%0AFor%20an%20m-by-n%20matrix%20A%20with%20m%20&gt;=%20n,%20the%20singular%20value%20decomposition%20is%0D%0Aan%20m-by-n%20orthogonal%20matrix%20U,%20an%20n-by-n%20diagonal%20matrix%20S,%20and%0D%0Aan%20n-by-n%20orthogonal%20matrix%20V%20so%20that%20A%20=%20U*S*V'.html"><i class="icon-folder-open"></i> JAMA

  42. For an m-by-n matrix A with m &gt;= n, the singular value decomposition is

  43. an m-by-n orthogonal matrix U, an n-by-n diagonal matrix S, and

  44. an n-by-n orthogonal matrix V so that A = U*S*V'</a></li>

  45. <li><a href="../packages/JAMA%0D%0APythagorean%20Theorem:%0D%0Aa%20=%203%0D%0Ab%20=%204%0D%0Ar%20=%20sqrt(square(a)%20+%20square(b))%0D%0Ar%20=%205%0D%0Ar%20=%20sqrt(a%5E2%20+%20b%5E2)%20without%20under.overflow.html"><i class="icon-folder-open"></i> JAMA

  46. Pythagorean Theorem:

  47. a = 3

  48. b = 4

  49. r = sqrt(square(a) + square(b))

  50. r = 5

  51. r = sqrt(a^2 + b^2) without under/overflow</a></li>

  52. <li><a href="../packages/PHPExcel.html"><i class="icon-folder-open"></i> PHPExcel</a></li>

  53. </ul>

  54. </li>

  55. <li class="dropdown" id="charts-menu">

  56. <a href="#charts" class="dropdown-toggle" data-toggle="dropdown">

  57.                                     Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>

  58. </li>

  59. <li class="dropdown" id="reports-menu">

  60. <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">

  61.                                     Reports <b class="caret"></b></a><ul class="dropdown-menu">

  62. <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 

  63.                 <span class="label label-info">551</span></a></li>

  64. <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 

  65.                 <ul>

  66. <li>todo 

  67.                 <span class="label label-info">19</span>

  68. </li>

  69. <li>fixme 

  70.                 <span class="label label-info">10</span>

  71. </li>

  72. </ul></a></li>

  73. <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 

  74.                 <span class="label label-info">12</span></a></li>

  75. </ul>

  76. </li>

  77. </ul></div>

  78. </div></div>

  79. <div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>

  80. </div>

  81. <div id="___" class="container">

  82. <noscript><div class="alert alert-warning">

  83.                             Javascript is disabled; several features are only available

  84.                             if Javascript is enabled.

  85.                         </div></noscript>

  86. <div class="row">

  87. <div class="span4">

  88. <span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">

  89. <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>

  90. </div>

  91. <ul class="side-nav nav nav-list">

  92. <li class="nav-header">

  93. <i class="icon-custom icon-method"></i> Methods

  94.                     <ul>

  95. <li class="method public "><a href="#method___construct" title="__construct :: Create a new PHPExcel_Writer_HTML"><span class="description">Create a new PHPExcel_Writer_HTML</span><pre>__construct()</pre></a></li>

  96. <li class="method public "><a href="#method_buildCSS" title="buildCSS :: Build CSS styles"><span class="description">Build CSS styles</span><pre>buildCSS()</pre></a></li>

  97. <li class="method public "><a href="#method_formatColor" title="formatColor :: Add color to formatted string as inline style"><span class="description">Add color to formatted string as inline style</span><pre>formatColor()</pre></a></li>

  98. <li class="method public "><a href="#method_generateHTMLFooter" title="generateHTMLFooter :: Generate HTML footer"><span class="description">Generate HTML footer</span><pre>generateHTMLFooter()</pre></a></li>

  99. <li class="method public "><a href="#method_generateHTMLHeader" title="generateHTMLHeader :: Generate HTML header"><span class="description">Generate HTML header</span><pre>generateHTMLHeader()</pre></a></li>

  100. <li class="method public "><a href="#method_generateNavigation" title="generateNavigation :: Generate sheet tabs"><span class="description">Generate sheet tabs</span><pre>generateNavigation()</pre></a></li>

  101. <li class="method public "><a href="#method_generateSheetData" title="generateSheetData :: Generate sheet data"><span class="description">Generate sheet data</span><pre>generateSheetData()</pre></a></li>

  102. <li class="method public "><a href="#method_generateStyles" title="generateStyles :: Generate CSS styles"><span class="description">Generate CSS styles</span><pre>generateStyles()</pre></a></li>

  103. <li class="method public inherited"><a href="#method_getDiskCachingDirectory" title="getDiskCachingDirectory :: Get disk caching directory"><span class="description">Get disk caching directory</span><pre>getDiskCachingDirectory()</pre></a></li>

  104. <li class="method public "><a href="#method_getEmbedImages" title="getEmbedImages :: Get embed images"><span class="description">Get embed images</span><pre>getEmbedImages()</pre></a></li>

  105. <li class="method public "><a href="#method_getGenerateSheetNavigationBlock" title="getGenerateSheetNavigationBlock :: Get sheet index"><span class="description">Get sheet index</span><pre>getGenerateSheetNavigationBlock()</pre></a></li>

  106. <li class="method public "><a href="#method_getImagesRoot" title="getImagesRoot :: Get images root"><span class="description">Get images root</span><pre>getImagesRoot()</pre></a></li>

  107. <li class="method public inherited"><a href="#method_getIncludeCharts" title="getIncludeCharts :: Write charts in workbook?

  108. 	If this is true, then the Writer will write definitions for any charts that exist in the PHPExcel object."><span class="description">Write charts in workbook?

  109. 	If this is true, then the Writer will write definitions for any charts that exist in the PHPExcel object.</span><pre>getIncludeCharts()</pre></a></li>

  110. <li class="method public inherited"><a href="#method_getPreCalculateFormulas" title="getPreCalculateFormulas :: Get Pre-Calculate Formulas flag

  111.     If this is true (the default), then the writer will recalculate all formulae in a workbook when saving,

  112.        so that the pre-calculated values are immediately available to MS Excel or other office spreadsheet

  113.        viewer when opening the file

  114.     If false, then formulae are not calculated on save."><span class="description">Get Pre-Calculate Formulas flag

  115.     If this is true (the default), then the writer will recalculate all formulae in a workbook when saving,

  116.        so that the pre-calculated values are immediately available to MS Excel or other office spreadsheet

  117.        viewer when opening the file

  118.     If false, then formulae are not calculated on save.</span><pre>getPreCalculateFormulas()</pre></a></li>

  119. <li class="method public "><a href="#method_getSheetIndex" title="getSheetIndex :: Get sheet index"><span class="description">Get sheet index</span><pre>getSheetIndex()</pre></a></li>

  120. <li class="method public inherited"><a href="#method_getUseDiskCaching" title="getUseDiskCaching :: Get use disk caching where possible?"><span class="description">Get use disk caching where possible?</span><pre>getUseDiskCaching()</pre></a></li>

  121. <li class="method public "><a href="#method_getUseInlineCss" title="getUseInlineCss :: Get use inline CSS?"><span class="description">Get use inline CSS?</span><pre>getUseInlineCss()</pre></a></li>

  122. <li class="method public "><a href="#method_save" title="save :: Save PHPExcel to file"><span class="description">Save PHPExcel to file</span><pre>save()</pre></a></li>

  123. <li class="method public "><a href="#method_setEmbedImages" title="setEmbedImages :: Set embed images"><span class="description">Set embed images</span><pre>setEmbedImages()</pre></a></li>

  124. <li class="method public "><a href="#method_setGenerateSheetNavigationBlock" title="setGenerateSheetNavigationBlock :: Set sheet index"><span class="description">Set sheet index</span><pre>setGenerateSheetNavigationBlock()</pre></a></li>

  125. <li class="method public "><a href="#method_setImagesRoot" title="setImagesRoot :: Set images root"><span class="description">Set images root</span><pre>setImagesRoot()</pre></a></li>

  126. <li class="method public inherited"><a href="#method_setIncludeCharts" title="setIncludeCharts :: Set write charts in workbook

  127. 	Set to true, to advise the Writer to include any charts that exist in the PHPExcel object."><span class="description">Set write charts in workbook

  128. 	Set to true, to advise the Writer to include any charts that exist in the PHPExcel object.</span><pre>setIncludeCharts()</pre></a></li>

  129. <li class="method public inherited"><a href="#method_setPreCalculateFormulas" title="setPreCalculateFormulas :: Set Pre-Calculate Formulas

  130. 	Set to true (the default) to advise the Writer to calculate all formulae on save

  131. 	Set to false to prevent precalculation of formulae on save."><span class="description">Set Pre-Calculate Formulas

  132. 	Set to true (the default) to advise the Writer to calculate all formulae on save

  133. 	Set to false to prevent precalculation of formulae on save.</span><pre>setPreCalculateFormulas()</pre></a></li>

  134. <li class="method public "><a href="#method_setSheetIndex" title="setSheetIndex :: Set sheet index"><span class="description">Set sheet index</span><pre>setSheetIndex()</pre></a></li>

  135. <li class="method public inherited"><a href="#method_setUseDiskCaching" title="setUseDiskCaching :: Set use disk caching where possible?"><span class="description">Set use disk caching where possible?</span><pre>setUseDiskCaching()</pre></a></li>

  136. <li class="method public "><a href="#method_setUseInlineCss" title="setUseInlineCss :: Set use inline CSS?"><span class="description">Set use inline CSS?</span><pre>setUseInlineCss()</pre></a></li>

  137. <li class="method public "><a href="#method_writeAllSheets" title="writeAllSheets :: Write all sheets (resets sheetIndex to NULL)"><span class="description">Write all sheets (resets sheetIndex to NULL)</span><pre>writeAllSheets()</pre></a></li>

  138. </ul>

  139. </li>

  140. <li class="nav-header private">» Private

  141.                     <ul>

  142. <li class="method private "><a href="#method__assembleCSS" title="_assembleCSS :: Takes array where of CSS properties / values and converts to CSS string"><span class="description">Takes array where of CSS properties / values and converts to CSS string</span><pre>_assembleCSS()</pre></a></li>

  143. <li class="method private "><a href="#method__calculateSpans" title="_calculateSpans :: Calculate information about HTML colspan and rowspan which is not always the same as Excel's"><span class="description">Calculate information about HTML colspan and rowspan which is not always the same as Excel's</span><pre>_calculateSpans()</pre></a></li>

  144. <li class="method private "><a href="#method__createCSSStyle" title="_createCSSStyle :: Create CSS style"><span class="description">Create CSS style</span><pre>_createCSSStyle()</pre></a></li>

  145. <li class="method private "><a href="#method__createCSSStyleAlignment" title="_createCSSStyleAlignment :: Create CSS style (PHPExcel_Style_Alignment)"><span class="description">Create CSS style (PHPExcel_Style_Alignment)</span><pre>_createCSSStyleAlignment()</pre></a></li>

  146. <li class="method private "><a href="#method__createCSSStyleBorder" title="_createCSSStyleBorder :: Create CSS style (PHPExcel_Style_Border)"><span class="description">Create CSS style (PHPExcel_Style_Border)</span><pre>_createCSSStyleBorder()</pre></a></li>

  147. <li class="method private "><a href="#method__createCSSStyleBorders" title="_createCSSStyleBorders :: Create CSS style (PHPExcel_Style_Borders)"><span class="description">Create CSS style (PHPExcel_Style_Borders)</span><pre>_createCSSStyleBorders()</pre></a></li>

  148. <li class="method private "><a href="#method__createCSSStyleFill" title="_createCSSStyleFill :: Create CSS style (PHPExcel_Style_Fill)"><span class="description">Create CSS style (PHPExcel_Style_Fill)</span><pre>_createCSSStyleFill()</pre></a></li>

  149. <li class="method private "><a href="#method__createCSSStyleFont" title="_createCSSStyleFont :: Create CSS style (PHPExcel_Style_Font)"><span class="description">Create CSS style (PHPExcel_Style_Font)</span><pre>_createCSSStyleFont()</pre></a></li>

  150. <li class="method private "><a href="#method__extendRowsForChartsAndImages" title="_extendRowsForChartsAndImages :: "><span class="description">_extendRowsForChartsAndImages()

  151.         </span><pre>_extendRowsForChartsAndImages()</pre></a></li>

  152. <li class="method private "><a href="#method__generateRow" title="_generateRow :: Generate row"><span class="description">Generate row</span><pre>_generateRow()</pre></a></li>

  153. <li class="method private "><a href="#method__generateTableFooter" title="_generateTableFooter :: Generate table footer"><span class="description">Generate table footer</span><pre>_generateTableFooter()</pre></a></li>

  154. <li class="method private "><a href="#method__generateTableHeader" title="_generateTableHeader :: Generate table header"><span class="description">Generate table header</span><pre>_generateTableHeader()</pre></a></li>

  155. <li class="method private "><a href="#method__mapBorderStyle" title="_mapBorderStyle :: Map border style"><span class="description">Map border style</span><pre>_mapBorderStyle()</pre></a></li>

  156. <li class="method private "><a href="#method__mapHAlign" title="_mapHAlign :: Map HAlign"><span class="description">Map HAlign</span><pre>_mapHAlign()</pre></a></li>

  157. <li class="method private "><a href="#method__mapVAlign" title="_mapVAlign :: Map VAlign"><span class="description">Map VAlign</span><pre>_mapVAlign()</pre></a></li>

  158. <li class="method private "><a href="#method__setMargins" title="_setMargins :: "><span class="description">_setMargins()

  159.         </span><pre>_setMargins()</pre></a></li>

  160. <li class="method private "><a href="#method__writeChartInCell" title="_writeChartInCell :: Generate chart tag in cell"><span class="description">Generate chart tag in cell</span><pre>_writeChartInCell()</pre></a></li>

  161. <li class="method private "><a href="#method__writeImageInCell" title="_writeImageInCell :: Generate image tag in cell"><span class="description">Generate image tag in cell</span><pre>_writeImageInCell()</pre></a></li>

  162. </ul>

  163. </li>

  164. <li class="nav-header">

  165. <i class="icon-custom icon-property"></i> Properties

  166.                     <ul></ul>

  167. </li>

  168. <li class="nav-header protected">» Protected

  169.                     <ul>

  170. <li class="property protected inherited"><a href="#property__diskCachingDirectory" title="$_diskCachingDirectory :: Disk caching directory"><span class="description"></span><pre>$_diskCachingDirectory</pre></a></li>

  171. <li class="property protected inherited"><a href="#property__includeCharts" title="$_includeCharts :: Write charts that are defined in the workbook?

  172. Identifies whether the Writer should write definitions for any charts that exist in the PHPExcel object;"><span class="description"></span><pre>$_includeCharts</pre></a></li>

  173. <li class="property protected "><a href="#property__isPdf" title="$_isPdf :: Is the current writer creating PDF?"><span class="description"></span><pre>$_isPdf</pre></a></li>

  174. <li class="property protected "><a href="#property__phpExcel" title="$_phpExcel :: PHPExcel object"><span class="description"></span><pre>$_phpExcel</pre></a></li>

  175. <li class="property protected inherited"><a href="#property__preCalculateFormulas" title="$_preCalculateFormulas :: Pre-calculate formulas

  176. Forces PHPExcel to recalculate all formulae in a workbook when saving, so that the pre-calculated values are

  177.    immediately available to MS Excel or other office spreadsheet viewer when opening the file"><span class="description"></span><pre>$_preCalculateFormulas</pre></a></li>

  178. <li class="property protected inherited"><a href="#property__useDiskCaching" title="$_useDiskCaching :: Use disk caching where possible?"><span class="description"></span><pre>$_useDiskCaching</pre></a></li>

  179. </ul>

  180. </li>

  181. <li class="nav-header private">» Private

  182.                     <ul>

  183. <li class="property private "><a href="#property__columnWidths" title="$_columnWidths :: Array of column widths in points"><span class="description"></span><pre>$_columnWidths</pre></a></li>

  184. <li class="property private "><a href="#property__cssStyles" title="$_cssStyles :: Array of CSS styles"><span class="description"></span><pre>$_cssStyles</pre></a></li>

  185. <li class="property private "><a href="#property__defaultFont" title="$_defaultFont :: Default font"><span class="description"></span><pre>$_defaultFont</pre></a></li>

  186. <li class="property private "><a href="#property__embedImages" title="$_embedImages :: embed images, or link to images"><span class="description"></span><pre>$_embedImages</pre></a></li>

  187. <li class="property private "><a href="#property__generateSheetNavigationBlock" title="$_generateSheetNavigationBlock :: Generate the Navigation block"><span class="description"></span><pre>$_generateSheetNavigationBlock</pre></a></li>

  188. <li class="property private "><a href="#property__imagesRoot" title="$_imagesRoot :: Images root"><span class="description"></span><pre>$_imagesRoot</pre></a></li>

  189. <li class="property private "><a href="#property__isBaseCell" title="$_isBaseCell :: Excel cells that are upper-left corner in a cell merge"><span class="description"></span><pre>$_isBaseCell</pre></a></li>

  190. <li class="property private "><a href="#property__isSpannedCell" title="$_isSpannedCell :: Excel cells that should not be written as HTML cells"><span class="description"></span><pre>$_isSpannedCell</pre></a></li>

  191. <li class="property private "><a href="#property__isSpannedRow" title="$_isSpannedRow :: Excel rows that should not be written as HTML rows"><span class="description"></span><pre>$_isSpannedRow</pre></a></li>

  192. <li class="property private "><a href="#property__sheetIndex" title="$_sheetIndex :: Sheet index to write"><span class="description"></span><pre>$_sheetIndex</pre></a></li>

  193. <li class="property private "><a href="#property__spansAreCalculated" title="$_spansAreCalculated :: Flag whether spans have been calculated"><span class="description"></span><pre>$_spansAreCalculated</pre></a></li>

  194. <li class="property private "><a href="#property__useInlineCss" title="$_useInlineCss :: Use inline CSS?"><span class="description"></span><pre>$_useInlineCss</pre></a></li>

  195. </ul>

  196. </li>

  197. </ul>

  198. </div>

  199. <div class="span8">

  200. <a id="\PHPExcel_Writer_HTML"></a><ul class="breadcrumb">

  201. <li>

  202. <a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>

  203. </li>

  204. <li><a href="../namespaces/global.html">global</a></li>

  205. <li class="active">

  206. <span class="divider">\</span><a href="../classes/PHPExcel_Writer_HTML.html">PHPExcel_Writer_HTML</a>

  207. </li>

  208. </ul>

  209. <div class="element class">

  210. <p class="short_description">PHPExcel_Writer_HTML</p>

  211. <div class="details">

  212. <div class="long_description"></div>

  213. <table class="table table-bordered">

  214. <tr>

  215. <th>category</th>

  216. <td>PHPExcel</td>

  217. </tr>

  218. <tr>

  219. <th>package</th>

  220. <td><a href="../packages/PHPExcel.Writer.HTML.html">PHPExcel_Writer_HTML</a></td>

  221. </tr>

  222. <tr>

  223. <th>copyright</th>

  224. <td>Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)</td>

  225. </tr>

  226. </table>

  227. <h3>

  228. <i class="icon-custom icon-method"></i> Methods</h3>

  229. <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">

  230. <h2>Create a new PHPExcel_Writer_HTML</h2>

  231. <pre>__construct(\PHPExcel $phpExcel) </pre>

  232. <div class="labels"></div>

  233. <div class="row collapse"><div class="detail-description">

  234. <div class="long_description"></div>

  235. <h3>Parameters</h3>

  236. <div class="subelement argument">

  237. <h4>$phpExcel</h4>

  238. <code><a href="../classes/PHPExcel.html">\PHPExcel</a></code><p>PHPExcel object</p></div>

  239. </div></div>

  240. </div>

  241. <a id="method_buildCSS"></a><div class="element clickable method public method_buildCSS" data-toggle="collapse" data-target=".method_buildCSS .collapse">

  242. <h2>Build CSS styles</h2>

  243. <pre>buildCSS(boolean $generateSurroundingHTML) : array</pre>

  244. <div class="labels"></div>

  245. <div class="row collapse"><div class="detail-description">

  246. <div class="long_description"></div>

  247. <h3>Parameters</h3>

  248. <div class="subelement argument">

  249. <h4>$generateSurroundingHTML</h4>

  250. <code>boolean</code><p>Generate surrounding HTML style? (html { })</p>

  251. </div>

  252. <h3>Exceptions</h3>

  253. <table class="table table-bordered"><tr>

  254. <th><code><a href="../classes/PHPExcel_Writer_Exception.html">\PHPExcel_Writer_Exception</a></code></th>

  255. <td></td>

  256. </tr></table>

  257. <h3>Returns</h3>

  258. <div class="subelement response"><code>array</code></div>

  259. </div></div>

  260. </div>

  261. <a id="method_formatColor"></a><div class="element clickable method public method_formatColor" data-toggle="collapse" data-target=".method_formatColor .collapse">

  262. <h2>Add color to formatted string as inline style</h2>

  263. <pre>formatColor(string $pValue, string $pFormat) : string</pre>

  264. <div class="labels"></div>

  265. <div class="row collapse"><div class="detail-description">

  266. <div class="long_description"></div>

  267. <h3>Parameters</h3>

  268. <div class="subelement argument">

  269. <h4>$pValue</h4>

  270. <code>string</code><p>Plain formatted value without color</p></div>

  271. <div class="subelement argument">

  272. <h4>$pFormat</h4>

  273. <code>string</code><p>Format code</p></div>

  274. <h3>Returns</h3>

  275. <div class="subelement response"><code>string</code></div>

  276. </div></div>

  277. </div>

  278. <a id="method_generateHTMLFooter"></a><div class="element clickable method public method_generateHTMLFooter" data-toggle="collapse" data-target=".method_generateHTMLFooter .collapse">

  279. <h2>Generate HTML footer</h2>

  280. <pre>generateHTMLFooter() </pre>

  281. <div class="labels"></div>

  282. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  283. </div>

  284. <a id="method_generateHTMLHeader"></a><div class="element clickable method public method_generateHTMLHeader" data-toggle="collapse" data-target=".method_generateHTMLHeader .collapse">

  285. <h2>Generate HTML header</h2>

  286. <pre>generateHTMLHeader(boolean $pIncludeStyles) : string</pre>

  287. <div class="labels"></div>

  288. <div class="row collapse"><div class="detail-description">

  289. <div class="long_description"></div>

  290. <h3>Parameters</h3>

  291. <div class="subelement argument">

  292. <h4>$pIncludeStyles</h4>

  293. <code>boolean</code><p>Include styles?</p>

  294. </div>

  295. <h3>Exceptions</h3>

  296. <table class="table table-bordered"><tr>

  297. <th><code><a href="../classes/PHPExcel_Writer_Exception.html">\PHPExcel_Writer_Exception</a></code></th>

  298. <td></td>

  299. </tr></table>

  300. <h3>Returns</h3>

  301. <div class="subelement response"><code>string</code></div>

  302. </div></div>

  303. </div>

  304. <a id="method_generateNavigation"></a><div class="element clickable method public method_generateNavigation" data-toggle="collapse" data-target=".method_generateNavigation .collapse">

  305. <h2>Generate sheet tabs</h2>

  306. <pre>generateNavigation() : string</pre>

  307. <div class="labels"></div>

  308. <div class="row collapse"><div class="detail-description">

  309. <div class="long_description"></div>

  310. <h3>Exceptions</h3>

  311. <table class="table table-bordered"><tr>

  312. <th><code><a href="../classes/PHPExcel_Writer_Exception.html">\PHPExcel_Writer_Exception</a></code></th>

  313. <td></td>

  314. </tr></table>

  315. <h3>Returns</h3>

  316. <div class="subelement response"><code>string</code></div>

  317. </div></div>

  318. </div>

  319. <a id="method_generateSheetData"></a><div class="element clickable method public method_generateSheetData" data-toggle="collapse" data-target=".method_generateSheetData .collapse">

  320. <h2>Generate sheet data</h2>

  321. <pre>generateSheetData() : string</pre>

  322. <div class="labels"></div>

  323. <div class="row collapse"><div class="detail-description">

  324. <div class="long_description"></div>

  325. <h3>Exceptions</h3>

  326. <table class="table table-bordered"><tr>

  327. <th><code><a href="../classes/PHPExcel_Writer_Exception.html">\PHPExcel_Writer_Exception</a></code></th>

  328. <td></td>

  329. </tr></table>

  330. <h3>Returns</h3>

  331. <div class="subelement response"><code>string</code></div>

  332. </div></div>

  333. </div>

  334. <a id="method_generateStyles"></a><div class="element clickable method public method_generateStyles" data-toggle="collapse" data-target=".method_generateStyles .collapse">

  335. <h2>Generate CSS styles</h2>

  336. <pre>generateStyles(boolean $generateSurroundingHTML) : string</pre>

  337. <div class="labels"></div>

  338. <div class="row collapse"><div class="detail-description">

  339. <div class="long_description"></div>

  340. <h3>Parameters</h3>

  341. <div class="subelement argument">

  342. <h4>$generateSurroundingHTML</h4>

  343. <code>boolean</code><p>Generate surrounding HTML tags? (<style> and </style>)</p>

  344. </div>

  345. <h3>Exceptions</h3>

  346. <table class="table table-bordered"><tr>

  347. <th><code><a href="../classes/PHPExcel_Writer_Exception.html">\PHPExcel_Writer_Exception</a></code></th>

  348. <td></td>

  349. </tr></table>

  350. <h3>Returns</h3>

  351. <div class="subelement response"><code>string</code></div>

  352. </div></div>

  353. </div>

  354. <a id="method_getDiskCachingDirectory"></a><div class="element clickable method public method_getDiskCachingDirectory" data-toggle="collapse" data-target=".method_getDiskCachingDirectory .collapse">

  355. <h2>Get disk caching directory</h2>

  356. <pre>getDiskCachingDirectory() : string</pre>

  357. <div class="labels"><span class="label">Inherited</span></div>

  358. <div class="row collapse"><div class="detail-description">

  359. <div class="long_description"></div>

  360. <table class="table table-bordered"><tr>

  361. <th>inherited_from</th>

  362. <td>\PHPExcel_Writer_Abstract::getDiskCachingDirectory()</td>

  363. </tr></table>

  364. <h3>Returns</h3>

  365. <div class="subelement response"><code>string</code></div>

  366. </div></div>

  367. </div>

  368. <a id="method_getEmbedImages"></a><div class="element clickable method public method_getEmbedImages" data-toggle="collapse" data-target=".method_getEmbedImages .collapse">

  369. <h2>Get embed images</h2>

  370. <pre>getEmbedImages() : boolean</pre>

  371. <div class="labels"></div>

  372. <div class="row collapse"><div class="detail-description">

  373. <div class="long_description"></div>

  374. <h3>Returns</h3>

  375. <div class="subelement response"><code>boolean</code></div>

  376. </div></div>

  377. </div>

  378. <a id="method_getGenerateSheetNavigationBlock"></a><div class="element clickable method public method_getGenerateSheetNavigationBlock" data-toggle="collapse" data-target=".method_getGenerateSheetNavigationBlock .collapse">

  379. <h2>Get sheet index</h2>

  380. <pre>getGenerateSheetNavigationBlock() : boolean</pre>

  381. <div class="labels"></div>

  382. <div class="row collapse"><div class="detail-description">

  383. <div class="long_description"></div>

  384. <h3>Returns</h3>

  385. <div class="subelement response"><code>boolean</code></div>

  386. </div></div>

  387. </div>

  388. <a id="method_getImagesRoot"></a><div class="element clickable method public method_getImagesRoot" data-toggle="collapse" data-target=".method_getImagesRoot .collapse">

  389. <h2>Get images root</h2>

  390. <pre>getImagesRoot() : string</pre>

  391. <div class="labels"></div>

  392. <div class="row collapse"><div class="detail-description">

  393. <div class="long_description"></div>

  394. <h3>Returns</h3>

  395. <div class="subelement response"><code>string</code></div>

  396. </div></div>

  397. </div>

  398. <a id="method_getIncludeCharts"></a><div class="element clickable method public method_getIncludeCharts" data-toggle="collapse" data-target=".method_getIncludeCharts .collapse">

  399. <h2>Write charts in workbook?

  400. 	If this is true, then the Writer will write definitions for any charts that exist in the PHPExcel object.</h2>

  401. <pre>getIncludeCharts() : boolean</pre>

  402. <div class="labels"><span class="label">Inherited</span></div>

  403. <div class="row collapse"><div class="detail-description">

  404. <div class="long_description"><p>If false (the default) it will ignore any charts defined in the PHPExcel object.</p></div>

  405. <table class="table table-bordered"><tr>

  406. <th>inherited_from</th>

  407. <td>\PHPExcel_Writer_Abstract::getIncludeCharts()</td>

  408. </tr></table>

  409. <h3>Returns</h3>

  410. <div class="subelement response"><code>boolean</code></div>

  411. </div></div>

  412. </div>

  413. <a id="method_getPreCalculateFormulas"></a><div class="element clickable method public method_getPreCalculateFormulas" data-toggle="collapse" data-target=".method_getPreCalculateFormulas .collapse">

  414. <h2>Get Pre-Calculate Formulas flag

  415.     If this is true (the default), then the writer will recalculate all formulae in a workbook when saving,

  416.        so that the pre-calculated values are immediately available to MS Excel or other office spreadsheet

  417.        viewer when opening the file

  418.     If false, then formulae are not calculated on save.</h2>

  419. <pre>getPreCalculateFormulas() : boolean</pre>

  420. <div class="labels"><span class="label">Inherited</span></div>

  421. <div class="row collapse"><div class="detail-description">

  422. <div class="long_description"><p>This is faster for saving in PHPExcel, but slower

  423.        when opening the resulting file in MS Excel, because Excel has to recalculate the formulae itself</p></div>

  424. <table class="table table-bordered"><tr>

  425. <th>inherited_from</th>

  426. <td>\PHPExcel_Writer_Abstract::getPreCalculateFormulas()</td>

  427. </tr></table>

  428. <h3>Returns</h3>

  429. <div class="subelement response"><code>boolean</code></div>

  430. </div></div>

  431. </div>

  432. <a id="method_getSheetIndex"></a><div class="element clickable method public method_getSheetIndex" data-toggle="collapse" data-target=".method_getSheetIndex .collapse">

  433. <h2>Get sheet index</h2>

  434. <pre>getSheetIndex() : int</pre>

  435. <div class="labels"></div>

  436. <div class="row collapse"><div class="detail-description">

  437. <div class="long_description"></div>

  438. <h3>Returns</h3>

  439. <div class="subelement response"><code>int</code></div>

  440. </div></div>

  441. </div>

  442. <a id="method_getUseDiskCaching"></a><div class="element clickable method public method_getUseDiskCaching" data-toggle="collapse" data-target=".method_getUseDiskCaching .collapse">

  443. <h2>Get use disk caching where possible?</h2>

  444. <pre>getUseDiskCaching() : boolean</pre>

  445. <div class="labels"><span class="label">Inherited</span></div>

  446. <div class="row collapse"><div class="detail-description">

  447. <div class="long_description"></div>

  448. <table class="table table-bordered"><tr>

  449. <th>inherited_from</th>

  450. <td>\PHPExcel_Writer_Abstract::getUseDiskCaching()</td>

  451. </tr></table>

  452. <h3>Returns</h3>

  453. <div class="subelement response"><code>boolean</code></div>

  454. </div></div>

  455. </div>

  456. <a id="method_getUseInlineCss"></a><div class="element clickable method public method_getUseInlineCss" data-toggle="collapse" data-target=".method_getUseInlineCss .collapse">

  457. <h2>Get use inline CSS?</h2>

  458. <pre>getUseInlineCss() : boolean</pre>

  459. <div class="labels"></div>

  460. <div class="row collapse"><div class="detail-description">

  461. <div class="long_description"></div>

  462. <h3>Returns</h3>

  463. <div class="subelement response"><code>boolean</code></div>

  464. </div></div>

  465. </div>

  466. <a id="method_save"></a><div class="element clickable method public method_save" data-toggle="collapse" data-target=".method_save .collapse">

  467. <h2>Save PHPExcel to file</h2>

  468. <pre>save(string $pFilename) </pre>

  469. <div class="labels"></div>

  470. <div class="row collapse"><div class="detail-description">

  471. <div class="long_description"><p>@param   string       $pFilename  Name of the file to save</p></div>

  472. <h3>Parameters</h3>

  473. <div class="subelement argument">

  474. <h4>$pFilename</h4>

  475. <code>string</code>

  476. </div>

  477. <h3>Exceptions</h3>

  478. <table class="table table-bordered"><tr>

  479. <th><code><a href="../classes/PHPExcel_Writer_Exception.html">\PHPExcel_Writer_Exception</a></code></th>

  480. <td></td>

  481. </tr></table>

  482. </div></div>

  483. </div>

  484. <a id="method_setEmbedImages"></a><div class="element clickable method public method_setEmbedImages" data-toggle="collapse" data-target=".method_setEmbedImages .collapse">

  485. <h2>Set embed images</h2>

  486. <pre>setEmbedImages(boolean $pValue) : <a href="../classes/PHPExcel_Writer_HTML.html">\PHPExcel_Writer_HTML</a></pre>

  487. <div class="labels"></div>

  488. <div class="row collapse"><div class="detail-description">

  489. <div class="long_description"></div>

  490. <h3>Parameters</h3>

  491. <div class="subelement argument">

  492. <h4>$pValue</h4>

  493. <code>boolean</code>

  494. </div>

  495. <h3>Returns</h3>

  496. <div class="subelement response"><code><a href="../classes/PHPExcel_Writer_HTML.html">\PHPExcel_Writer_HTML</a></code></div>

  497. </div></div>

  498. </div>

  499. <a id="method_setGenerateSheetNavigationBlock"></a><div class="element clickable method public method_setGenerateSheetNavigationBlock" data-toggle="collapse" data-target=".method_setGenerateSheetNavigationBlock .collapse">

  500. <h2>Set sheet index</h2>

  501. <pre>setGenerateSheetNavigationBlock(boolean $pValue) : <a href="../classes/PHPExcel_Writer_HTML.html">\PHPExcel_Writer_HTML</a></pre>

  502. <div class="labels"></div>

  503. <div class="row collapse"><div class="detail-description">

  504. <div class="long_description"></div>

  505. <h3>Parameters</h3>

  506. <div class="subelement argument">

  507. <h4>$pValue</h4>

  508. <code>boolean</code><p>Flag indicating whether the sheet navigation block should be generated or not</p></div>

  509. <h3>Returns</h3>

  510. <div class="subelement response"><code><a href="../classes/PHPExcel_Writer_HTML.html">\PHPExcel_Writer_HTML</a></code></div>

  511. </div></div>

  512. </div>

  513. <a id="method_setImagesRoot"></a><div class="element clickable method public method_setImagesRoot" data-toggle="collapse" data-target=".method_setImagesRoot .collapse">

  514. <h2>Set images root</h2>

  515. <pre>setImagesRoot(string $pValue) : <a href="../classes/PHPExcel_Writer_HTML.html">\PHPExcel_Writer_HTML</a></pre>

  516. <div class="labels"></div>

  517. <div class="row collapse"><div class="detail-description">

  518. <div class="long_description"></div>

  519. <h3>Parameters</h3>

  520. <div class="subelement argument">

  521. <h4>$pValue</h4>

  522. <code>string</code>

  523. </div>

  524. <h3>Returns</h3>

  525. <div class="subelement response"><code><a href="../classes/PHPExcel_Writer_HTML.html">\PHPExcel_Writer_HTML</a></code></div>

  526. </div></div>

  527. </div>

  528. <a id="method_setIncludeCharts"></a><div class="element clickable method public method_setIncludeCharts" data-toggle="collapse" data-target=".method_setIncludeCharts .collapse">

  529. <h2>Set write charts in workbook

  530. 	Set to true, to advise the Writer to include any charts that exist in the PHPExcel object.</h2>

  531. <pre>setIncludeCharts(boolean $pValue) : <a href="../classes/PHPExcel_Writer_IWriter.html">\PHPExcel_Writer_IWriter</a></pre>

  532. <div class="labels"><span class="label">Inherited</span></div>

  533. <div class="row collapse"><div class="detail-description">

  534. <div class="long_description"><p>Set to false (the default) to ignore charts.</p></div>

  535. <table class="table table-bordered"><tr>

  536. <th>inherited_from</th>

  537. <td>\PHPExcel_Writer_Abstract::setIncludeCharts()</td>

  538. </tr></table>

  539. <h3>Parameters</h3>

  540. <div class="subelement argument">

  541. <h4>$pValue</h4>

  542. <code>boolean</code>

  543. </div>

  544. <h3>Returns</h3>

  545. <div class="subelement response"><code><a href="../classes/PHPExcel_Writer_IWriter.html">\PHPExcel_Writer_IWriter</a></code></div>

  546. </div></div>

  547. </div>

  548. <a id="method_setPreCalculateFormulas"></a><div class="element clickable method public method_setPreCalculateFormulas" data-toggle="collapse" data-target=".method_setPreCalculateFormulas .collapse">

  549. <h2>Set Pre-Calculate Formulas

  550. 	Set to true (the default) to advise the Writer to calculate all formulae on save

  551. 	Set to false to prevent precalculation of formulae on save.</h2>

  552. <pre>setPreCalculateFormulas(boolean $pValue) : <a href="../classes/PHPExcel_Writer_IWriter.html">\PHPExcel_Writer_IWriter</a></pre>

  553. <div class="labels"><span class="label">Inherited</span></div>

  554. <div class="row collapse"><div class="detail-description">

  555. <div class="long_description"></div>

  556. <table class="table table-bordered"><tr>

  557. <th>inherited_from</th>

  558. <td>\PHPExcel_Writer_Abstract::setPreCalculateFormulas()</td>

  559. </tr></table>

  560. <h3>Parameters</h3>

  561. <div class="subelement argument">

  562. <h4>$pValue</h4>

  563. <code>boolean</code><p>Pre-Calculate Formulas?</p>

  564. </div>

  565. <h3>Returns</h3>

  566. <div class="subelement response"><code><a href="../classes/PHPExcel_Writer_IWriter.html">\PHPExcel_Writer_IWriter</a></code></div>

  567. </div></div>

  568. </div>

  569. <a id="method_setSheetIndex"></a><div class="element clickable method public method_setSheetIndex" data-toggle="collapse" data-target=".method_setSheetIndex .collapse">

  570. <h2>Set sheet index</h2>

  571. <pre>setSheetIndex(int $pValue) : <a href="../classes/PHPExcel_Writer_HTML.html">\PHPExcel_Writer_HTML</a></pre>

  572. <div class="labels"></div>

  573. <div class="row collapse"><div class="detail-description">

  574. <div class="long_description"></div>

  575. <h3>Parameters</h3>

  576. <div class="subelement argument">

  577. <h4>$pValue</h4>

  578. <code>int</code><p>Sheet index</p></div>

  579. <h3>Returns</h3>

  580. <div class="subelement response"><code><a href="../classes/PHPExcel_Writer_HTML.html">\PHPExcel_Writer_HTML</a></code></div>

  581. </div></div>

  582. </div>

  583. <a id="method_setUseDiskCaching"></a><div class="element clickable method public method_setUseDiskCaching" data-toggle="collapse" data-target=".method_setUseDiskCaching .collapse">

  584. <h2>Set use disk caching where possible?</h2>

  585. <pre>setUseDiskCaching(boolean $pValue, string $pDirectory) : <a href="../classes/PHPExcel_Writer_Excel2007.html">\PHPExcel_Writer_Excel2007</a></pre>

  586. <div class="labels"><span class="label">Inherited</span></div>

  587. <div class="row collapse"><div class="detail-description">

  588. <div class="long_description"></div>

  589. <table class="table table-bordered"><tr>

  590. <th>inherited_from</th>

  591. <td>\PHPExcel_Writer_Abstract::setUseDiskCaching()</td>

  592. </tr></table>

  593. <h3>Parameters</h3>

  594. <div class="subelement argument">

  595. <h4>$pValue</h4>

  596. <code>boolean</code>

  597. </div>

  598. <div class="subelement argument">

  599. <h4>$pDirectory</h4>

  600. <code>string</code><p>Disk caching directory</p></div>

  601. <h3>Exceptions</h3>

  602. <table class="table table-bordered"><tr>

  603. <th><code><a href="../classes/PHPExcel_Writer_Exception.html">\PHPExcel_Writer_Exception</a></code></th>

  604. <td>when directory does not exist</td>

  605. </tr></table>

  606. <h3>Returns</h3>

  607. <div class="subelement response"><code><a href="../classes/PHPExcel_Writer_Excel2007.html">\PHPExcel_Writer_Excel2007</a></code></div>

  608. </div></div>

  609. </div>

  610. <a id="method_setUseInlineCss"></a><div class="element clickable method public method_setUseInlineCss" data-toggle="collapse" data-target=".method_setUseInlineCss .collapse">

  611. <h2>Set use inline CSS?</h2>

  612. <pre>setUseInlineCss(boolean $pValue) : <a href="../classes/PHPExcel_Writer_HTML.html">\PHPExcel_Writer_HTML</a></pre>

  613. <div class="labels"></div>

  614. <div class="row collapse"><div class="detail-description">

  615. <div class="long_description"></div>

  616. <h3>Parameters</h3>

  617. <div class="subelement argument">

  618. <h4>$pValue</h4>

  619. <code>boolean</code>

  620. </div>

  621. <h3>Returns</h3>

  622. <div class="subelement response"><code><a href="../classes/PHPExcel_Writer_HTML.html">\PHPExcel_Writer_HTML</a></code></div>

  623. </div></div>

  624. </div>

  625. <a id="method_writeAllSheets"></a><div class="element clickable method public method_writeAllSheets" data-toggle="collapse" data-target=".method_writeAllSheets .collapse">

  626. <h2>Write all sheets (resets sheetIndex to NULL)</h2>

  627. <pre>writeAllSheets() </pre>

  628. <div class="labels"></div>

  629. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  630. </div>

  631. <a id="method__assembleCSS"></a><div class="element clickable method private method__assembleCSS" data-toggle="collapse" data-target=".method__assembleCSS .collapse">

  632. <h2>Takes array where of CSS properties / values and converts to CSS string</h2>

  633. <pre>_assembleCSS(array $pValue) : string</pre>

  634. <div class="labels"></div>

  635. <div class="row collapse"><div class="detail-description">

  636. <div class="long_description"></div>

  637. <h3>Parameters</h3>

  638. <div class="subelement argument">

  639. <h4>$pValue</h4>

  640. <code>array</code>

  641. </div>

  642. <h3>Returns</h3>

  643. <div class="subelement response"><code>string</code></div>

  644. </div></div>

  645. </div>

  646. <a id="method__calculateSpans"></a><div class="element clickable method private method__calculateSpans" data-toggle="collapse" data-target=".method__calculateSpans .collapse">

  647. <h2>Calculate information about HTML colspan and rowspan which is not always the same as Excel's</h2>

  648. <pre>_calculateSpans() </pre>

  649. <div class="labels"></div>

  650. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  651. </div>

  652. <a id="method__createCSSStyle"></a><div class="element clickable method private method__createCSSStyle" data-toggle="collapse" data-target=".method__createCSSStyle .collapse">

  653. <h2>Create CSS style</h2>

  654. <pre>_createCSSStyle(\PHPExcel_Style $pStyle) : array</pre>

  655. <div class="labels"></div>

  656. <div class="row collapse"><div class="detail-description">

  657. <div class="long_description"></div>

  658. <h3>Parameters</h3>

  659. <div class="subelement argument">

  660. <h4>$pStyle</h4>

  661. <code><a href="../classes/PHPExcel_Style.html">\PHPExcel_Style</a></code><p>PHPExcel_Style</p></div>

  662. <h3>Returns</h3>

  663. <div class="subelement response"><code>array</code></div>

  664. </div></div>

  665. </div>

  666. <a id="method__createCSSStyleAlignment"></a><div class="element clickable method private method__createCSSStyleAlignment" data-toggle="collapse" data-target=".method__createCSSStyleAlignment .collapse">

  667. <h2>Create CSS style (PHPExcel_Style_Alignment)</h2>

  668. <pre>_createCSSStyleAlignment(\PHPExcel_Style_Alignment $pStyle) : array</pre>

  669. <div class="labels"></div>

  670. <div class="row collapse"><div class="detail-description">

  671. <div class="long_description"></div>

  672. <h3>Parameters</h3>

  673. <div class="subelement argument">

  674. <h4>$pStyle</h4>

  675. <code><a href="../classes/PHPExcel_Style_Alignment.html">\PHPExcel_Style_Alignment</a></code><p>PHPExcel_Style_Alignment</p></div>

  676. <h3>Returns</h3>

  677. <div class="subelement response"><code>array</code></div>

  678. </div></div>

  679. </div>

  680. <a id="method__createCSSStyleBorder"></a><div class="element clickable method private method__createCSSStyleBorder" data-toggle="collapse" data-target=".method__createCSSStyleBorder .collapse">

  681. <h2>Create CSS style (PHPExcel_Style_Border)</h2>

  682. <pre>_createCSSStyleBorder(\PHPExcel_Style_Border $pStyle) : string</pre>

  683. <div class="labels"></div>

  684. <div class="row collapse"><div class="detail-description">

  685. <div class="long_description"></div>

  686. <h3>Parameters</h3>

  687. <div class="subelement argument">

  688. <h4>$pStyle</h4>

  689. <code><a href="../classes/PHPExcel_Style_Border.html">\PHPExcel_Style_Border</a></code><p>PHPExcel_Style_Border</p></div>

  690. <h3>Returns</h3>

  691. <div class="subelement response"><code>string</code></div>

  692. </div></div>

  693. </div>

  694. <a id="method__createCSSStyleBorders"></a><div class="element clickable method private method__createCSSStyleBorders" data-toggle="collapse" data-target=".method__createCSSStyleBorders .collapse">

  695. <h2>Create CSS style (PHPExcel_Style_Borders)</h2>

  696. <pre>_createCSSStyleBorders(\PHPExcel_Style_Borders $pStyle) : array</pre>

  697. <div class="labels"></div>

  698. <div class="row collapse"><div class="detail-description">

  699. <div class="long_description"></div>

  700. <h3>Parameters</h3>

  701. <div class="subelement argument">

  702. <h4>$pStyle</h4>

  703. <code><a href="../classes/PHPExcel_Style_Borders.html">\PHPExcel_Style_Borders</a></code><p>PHPExcel_Style_Borders</p></div>

  704. <h3>Returns</h3>

  705. <div class="subelement response"><code>array</code></div>

  706. </div></div>

  707. </div>

  708. <a id="method__createCSSStyleFill"></a><div class="element clickable method private method__createCSSStyleFill" data-toggle="collapse" data-target=".method__createCSSStyleFill .collapse">

  709. <h2>Create CSS style (PHPExcel_Style_Fill)</h2>

  710. <pre>_createCSSStyleFill(\PHPExcel_Style_Fill $pStyle) : array</pre>

  711. <div class="labels"></div>

  712. <div class="row collapse"><div class="detail-description">

  713. <div class="long_description"></div>

  714. <h3>Parameters</h3>

  715. <div class="subelement argument">

  716. <h4>$pStyle</h4>

  717. <code><a href="../classes/PHPExcel_Style_Fill.html">\PHPExcel_Style_Fill</a></code><p>PHPExcel_Style_Fill</p></div>

  718. <h3>Returns</h3>

  719. <div class="subelement response"><code>array</code></div>

  720. </div></div>

  721. </div>

  722. <a id="method__createCSSStyleFont"></a><div class="element clickable method private method__createCSSStyleFont" data-toggle="collapse" data-target=".method__createCSSStyleFont .collapse">

  723. <h2>Create CSS style (PHPExcel_Style_Font)</h2>

  724. <pre>_createCSSStyleFont(\PHPExcel_Style_Font $pStyle) : array</pre>

  725. <div class="labels"></div>

  726. <div class="row collapse"><div class="detail-description">

  727. <div class="long_description"></div>

  728. <h3>Parameters</h3>

  729. <div class="subelement argument">

  730. <h4>$pStyle</h4>

  731. <code><a href="../classes/PHPExcel_Style_Font.html">\PHPExcel_Style_Font</a></code><p>PHPExcel_Style_Font</p></div>

  732. <h3>Returns</h3>

  733. <div class="subelement response"><code>array</code></div>

  734. </div></div>

  735. </div>

  736. <a id="method__extendRowsForChartsAndImages"></a><div class="element clickable method private method__extendRowsForChartsAndImages" data-toggle="collapse" data-target=".method__extendRowsForChartsAndImages .collapse">

  737. <h2>_extendRowsForChartsAndImages()

  738.         </h2>

  739. <pre>_extendRowsForChartsAndImages(\PHPExcel_Worksheet $pSheet, $row) </pre>

  740. <div class="labels"></div>

  741. <div class="row collapse"><div class="detail-description">

  742. <div class="long_description"></div>

  743. <h3>Parameters</h3>

  744. <div class="subelement argument"><h4>$pSheet</h4></div>

  745. <div class="subelement argument"><h4>$row</h4></div>

  746. </div></div>

  747. </div>

  748. <a id="method__generateRow"></a><div class="element clickable method private method__generateRow" data-toggle="collapse" data-target=".method__generateRow .collapse">

  749. <h2>Generate row</h2>

  750. <pre>_generateRow(\PHPExcel_Worksheet $pSheet, array $pValues, int $pRow) : string</pre>

  751. <div class="labels"></div>

  752. <div class="row collapse"><div class="detail-description">

  753. <div class="long_description"></div>

  754. <h3>Parameters</h3>

  755. <div class="subelement argument">

  756. <h4>$pSheet</h4>

  757. <code><a href="../classes/PHPExcel_Worksheet.html">\PHPExcel_Worksheet</a></code><p>PHPExcel_Worksheet</p></div>

  758. <div class="subelement argument">

  759. <h4>$pValues</h4>

  760. <code>array</code><p>Array containing cells in a row</p></div>

  761. <div class="subelement argument">

  762. <h4>$pRow</h4>

  763. <code>int</code><p>Row number (0-based)</p>

  764. </div>

  765. <h3>Exceptions</h3>

  766. <table class="table table-bordered"><tr>

  767. <th><code><a href="../classes/PHPExcel_Writer_Exception.html">\PHPExcel_Writer_Exception</a></code></th>

  768. <td></td>

  769. </tr></table>

  770. <h3>Returns</h3>

  771. <div class="subelement response"><code>string</code></div>

  772. </div></div>

  773. </div>

  774. <a id="method__generateTableFooter"></a><div class="element clickable method private method__generateTableFooter" data-toggle="collapse" data-target=".method__generateTableFooter .collapse">

  775. <h2>Generate table footer</h2>

  776. <pre>_generateTableFooter() </pre>

  777. <div class="labels"></div>

  778. <div class="row collapse"><div class="detail-description">

  779. <div class="long_description"></div>

  780. <h3>Exceptions</h3>

  781. <table class="table table-bordered"><tr>

  782. <th><code><a href="../classes/PHPExcel_Writer_Exception.html">\PHPExcel_Writer_Exception</a></code></th>

  783. <td></td>

  784. </tr></table>

  785. </div></div>

  786. </div>

  787. <a id="method__generateTableHeader"></a><div class="element clickable method private method__generateTableHeader" data-toggle="collapse" data-target=".method__generateTableHeader .collapse">

  788. <h2>Generate table header</h2>

  789. <pre>_generateTableHeader(<a href="../classes/PHPExcel_Worksheet.html">\PHPExcel_Worksheet</a> $pSheet) : string</pre>

  790. <div class="labels"></div>

  791. <div class="row collapse"><div class="detail-description">

  792. <div class="long_description"></div>

  793. <h3>Parameters</h3>

  794. <div class="subelement argument">

  795. <h4>$pSheet</h4>

  796. <code><a href="../classes/PHPExcel_Worksheet.html">\PHPExcel_Worksheet</a></code><p>The worksheet for the table we are writing</p></div>

  797. <h3>Exceptions</h3>

  798. <table class="table table-bordered"><tr>

  799. <th><code><a href="../classes/PHPExcel_Writer_Exception.html">\PHPExcel_Writer_Exception</a></code></th>

  800. <td></td>

  801. </tr></table>

  802. <h3>Returns</h3>

  803. <div class="subelement response"><code>string</code></div>

  804. </div></div>

  805. </div>

  806. <a id="method__mapBorderStyle"></a><div class="element clickable method private method__mapBorderStyle" data-toggle="collapse" data-target=".method__mapBorderStyle .collapse">

  807. <h2>Map border style</h2>

  808. <pre>_mapBorderStyle(int $borderStyle) : string</pre>

  809. <div class="labels"></div>

  810. <div class="row collapse"><div class="detail-description">

  811. <div class="long_description"></div>

  812. <h3>Parameters</h3>

  813. <div class="subelement argument">

  814. <h4>$borderStyle</h4>

  815. <code>int</code><p>Sheet index</p></div>

  816. <h3>Returns</h3>

  817. <div class="subelement response"><code>string</code></div>

  818. </div></div>

  819. </div>

  820. <a id="method__mapHAlign"></a><div class="element clickable method private method__mapHAlign" data-toggle="collapse" data-target=".method__mapHAlign .collapse">

  821. <h2>Map HAlign</h2>

  822. <pre>_mapHAlign(string $hAlign) : string | false</pre>

  823. <div class="labels"></div>

  824. <div class="row collapse"><div class="detail-description">

  825. <div class="long_description"></div>

  826. <h3>Parameters</h3>

  827. <div class="subelement argument">

  828. <h4>$hAlign</h4>

  829. <code>string</code><p>Horizontal alignment</p></div>

  830. <h3>Returns</h3>

  831. <div class="subelement response">

  832. <code>string</code><code>false</code>

  833. </div>

  834. </div></div>

  835. </div>

  836. <a id="method__mapVAlign"></a><div class="element clickable method private method__mapVAlign" data-toggle="collapse" data-target=".method__mapVAlign .collapse">

  837. <h2>Map VAlign</h2>

  838. <pre>_mapVAlign(string $vAlign) : string</pre>

  839. <div class="labels"></div>

  840. <div class="row collapse"><div class="detail-description">

  841. <div class="long_description"></div>

  842. <h3>Parameters</h3>

  843. <div class="subelement argument">

  844. <h4>$vAlign</h4>

  845. <code>string</code><p>Vertical alignment</p></div>

  846. <h3>Returns</h3>

  847. <div class="subelement response"><code>string</code></div>

  848. </div></div>

  849. </div>

  850. <a id="method__setMargins"></a><div class="element clickable method private method__setMargins" data-toggle="collapse" data-target=".method__setMargins .collapse">

  851. <h2>_setMargins()

  852.         </h2>

  853. <pre>_setMargins(\PHPExcel_Worksheet $pSheet) </pre>

  854. <div class="labels"></div>

  855. <div class="row collapse"><div class="detail-description">

  856. <div class="long_description"></div>

  857. <h3>Parameters</h3>

  858. <div class="subelement argument"><h4>$pSheet</h4></div>

  859. </div></div>

  860. </div>

  861. <a id="method__writeChartInCell"></a><div class="element clickable method private method__writeChartInCell" data-toggle="collapse" data-target=".method__writeChartInCell .collapse">

  862. <h2>Generate chart tag in cell</h2>

  863. <pre>_writeChartInCell(\PHPExcel_Worksheet $pSheet, string $coordinates) : string</pre>

  864. <div class="labels"></div>

  865. <div class="row collapse"><div class="detail-description">

  866. <div class="long_description"></div>

  867. <h3>Parameters</h3>

  868. <div class="subelement argument">

  869. <h4>$pSheet</h4>

  870. <code><a href="../classes/PHPExcel_Worksheet.html">\PHPExcel_Worksheet</a></code><p>PHPExcel_Worksheet</p></div>

  871. <div class="subelement argument">

  872. <h4>$coordinates</h4>

  873. <code>string</code><p>Cell coordinates</p></div>

  874. <h3>Exceptions</h3>

  875. <table class="table table-bordered"><tr>

  876. <th><code><a href="../classes/PHPExcel_Writer_Exception.html">\PHPExcel_Writer_Exception</a></code></th>

  877. <td></td>

  878. </tr></table>

  879. <h3>Returns</h3>

  880. <div class="subelement response"><code>string</code></div>

  881. </div></div>

  882. </div>

  883. <a id="method__writeImageInCell"></a><div class="element clickable method private method__writeImageInCell" data-toggle="collapse" data-target=".method__writeImageInCell .collapse">

  884. <h2>Generate image tag in cell</h2>

  885. <pre>_writeImageInCell(\PHPExcel_Worksheet $pSheet, string $coordinates) : string</pre>

  886. <div class="labels"></div>

  887. <div class="row collapse"><div class="detail-description">

  888. <div class="long_description"></div>

  889. <h3>Parameters</h3>

  890. <div class="subelement argument">

  891. <h4>$pSheet</h4>

  892. <code><a href="../classes/PHPExcel_Worksheet.html">\PHPExcel_Worksheet</a></code><p>PHPExcel_Worksheet</p></div>

  893. <div class="subelement argument">

  894. <h4>$coordinates</h4>

  895. <code>string</code><p>Cell coordinates</p></div>

  896. <h3>Exceptions</h3>

  897. <table class="table table-bordered"><tr>

  898. <th><code><a href="../classes/PHPExcel_Writer_Exception.html">\PHPExcel_Writer_Exception</a></code></th>

  899. <td></td>

  900. </tr></table>

  901. <h3>Returns</h3>

  902. <div class="subelement response"><code>string</code></div>

  903. </div></div>

  904. </div>

  905. <h3>

  906. <i class="icon-custom icon-property"></i> Properties</h3>

  907. <a id="property__diskCachingDirectory"> </a><div class="element clickable property protected property__diskCachingDirectory" data-toggle="collapse" data-target=".property__diskCachingDirectory .collapse">

  908. <h2></h2>

  909. <pre>$_diskCachingDirectory : string</pre>

  910. <div class="labels"><span class="label">Inherited</span></div>

  911. <div class="row collapse"><div class="detail-description">

  912. <div class="long_description"></div>

  913. <table class="table table-bordered"><tr>

  914. <th>inherited_from</th>

  915. <td>\PHPExcel_Writer_Abstract::$$_diskCachingDirectory</td>

  916. </tr></table>

  917. </div></div>

  918. </div>

  919. <a id="property__includeCharts"> </a><div class="element clickable property protected property__includeCharts" data-toggle="collapse" data-target=".property__includeCharts .collapse">

  920. <h2></h2>

  921. <pre>$_includeCharts : boolean</pre>

  922. <div class="labels"><span class="label">Inherited</span></div>

  923. <div class="row collapse"><div class="detail-description">

  924. <div class="long_description"></div>

  925. <table class="table table-bordered"><tr>

  926. <th>inherited_from</th>

  927. <td>\PHPExcel_Writer_Abstract::$$_includeCharts</td>

  928. </tr></table>

  929. </div></div>

  930. </div>

  931. <a id="property__isPdf"> </a><div class="element clickable property protected property__isPdf" data-toggle="collapse" data-target=".property__isPdf .collapse">

  932. <h2></h2>

  933. <pre>$_isPdf : boolean</pre>

  934. <div class="labels"></div>

  935. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  936. </div>

  937. <a id="property__phpExcel"> </a><div class="element clickable property protected property__phpExcel" data-toggle="collapse" data-target=".property__phpExcel .collapse">

  938. <h2></h2>

  939. <pre>$_phpExcel : <a href="../classes/PHPExcel.html">\PHPExcel</a></pre>

  940. <div class="labels"></div>

  941. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  942. </div>

  943. <a id="property__preCalculateFormulas"> </a><div class="element clickable property protected property__preCalculateFormulas" data-toggle="collapse" data-target=".property__preCalculateFormulas .collapse">

  944. <h2></h2>

  945. <pre>$_preCalculateFormulas : boolean</pre>

  946. <div class="labels"><span class="label">Inherited</span></div>

  947. <div class="row collapse"><div class="detail-description">

  948. <div class="long_description"></div>

  949. <table class="table table-bordered"><tr>

  950. <th>inherited_from</th>

  951. <td>\PHPExcel_Writer_Abstract::$$_preCalculateFormulas</td>

  952. </tr></table>

  953. </div></div>

  954. </div>

  955. <a id="property__useDiskCaching"> </a><div class="element clickable property protected property__useDiskCaching" data-toggle="collapse" data-target=".property__useDiskCaching .collapse">

  956. <h2></h2>

  957. <pre>$_useDiskCaching : boolean</pre>

  958. <div class="labels"><span class="label">Inherited</span></div>

  959. <div class="row collapse"><div class="detail-description">

  960. <div class="long_description"></div>

  961. <table class="table table-bordered"><tr>

  962. <th>inherited_from</th>

  963. <td>\PHPExcel_Writer_Abstract::$$_useDiskCaching</td>

  964. </tr></table>

  965. </div></div>

  966. </div>

  967. <a id="property__columnWidths"> </a><div class="element clickable property private property__columnWidths" data-toggle="collapse" data-target=".property__columnWidths .collapse">

  968. <h2></h2>

  969. <pre>$_columnWidths : array</pre>

  970. <div class="labels"></div>

  971. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  972. </div>

  973. <a id="property__cssStyles"> </a><div class="element clickable property private property__cssStyles" data-toggle="collapse" data-target=".property__cssStyles .collapse">

  974. <h2></h2>

  975. <pre>$_cssStyles : array</pre>

  976. <div class="labels"></div>

  977. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  978. </div>

  979. <a id="property__defaultFont"> </a><div class="element clickable property private property__defaultFont" data-toggle="collapse" data-target=".property__defaultFont .collapse">

  980. <h2></h2>

  981. <pre>$_defaultFont : <a href="../classes/PHPExcel_Style_Font.html">\PHPExcel_Style_Font</a></pre>

  982. <div class="labels"></div>

  983. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  984. </div>

  985. <a id="property__embedImages"> </a><div class="element clickable property private property__embedImages" data-toggle="collapse" data-target=".property__embedImages .collapse">

  986. <h2></h2>

  987. <pre>$_embedImages : boolean</pre>

  988. <div class="labels"></div>

  989. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  990. </div>

  991. <a id="property__generateSheetNavigationBlock"> </a><div class="element clickable property private property__generateSheetNavigationBlock" data-toggle="collapse" data-target=".property__generateSheetNavigationBlock .collapse">

  992. <h2></h2>

  993. <pre>$_generateSheetNavigationBlock : boolean</pre>

  994. <div class="labels"></div>

  995. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  996. </div>

  997. <a id="property__imagesRoot"> </a><div class="element clickable property private property__imagesRoot" data-toggle="collapse" data-target=".property__imagesRoot .collapse">

  998. <h2></h2>

  999. <pre>$_imagesRoot : string</pre>

  1000. <div class="labels"></div>

  1001. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  1002. </div>

  1003. <a id="property__isBaseCell"> </a><div class="element clickable property private property__isBaseCell" data-toggle="collapse" data-target=".property__isBaseCell .collapse">

  1004. <h2></h2>

  1005. <pre>$_isBaseCell : array</pre>

  1006. <div class="labels"></div>

  1007. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  1008. </div>

  1009. <a id="property__isSpannedCell"> </a><div class="element clickable property private property__isSpannedCell" data-toggle="collapse" data-target=".property__isSpannedCell .collapse">

  1010. <h2></h2>

  1011. <pre>$_isSpannedCell : array</pre>

  1012. <div class="labels"></div>

  1013. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  1014. </div>

  1015. <a id="property__isSpannedRow"> </a><div class="element clickable property private property__isSpannedRow" data-toggle="collapse" data-target=".property__isSpannedRow .collapse">

  1016. <h2></h2>

  1017. <pre>$_isSpannedRow : array</pre>

  1018. <div class="labels"></div>

  1019. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  1020. </div>

  1021. <a id="property__sheetIndex"> </a><div class="element clickable property private property__sheetIndex" data-toggle="collapse" data-target=".property__sheetIndex .collapse">

  1022. <h2></h2>

  1023. <pre>$_sheetIndex : int</pre>

  1024. <div class="labels"></div>

  1025. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  1026. </div>

  1027. <a id="property__spansAreCalculated"> </a><div class="element clickable property private property__spansAreCalculated" data-toggle="collapse" data-target=".property__spansAreCalculated .collapse">

  1028. <h2></h2>

  1029. <pre>$_spansAreCalculated : boolean</pre>

  1030. <div class="labels"></div>

  1031. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  1032. </div>

  1033. <a id="property__useInlineCss"> </a><div class="element clickable property private property__useInlineCss" data-toggle="collapse" data-target=".property__useInlineCss .collapse">

  1034. <h2></h2>

  1035. <pre>$_useInlineCss : boolean</pre>

  1036. <div class="labels"></div>

  1037. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  1038. </div>

  1039. </div>

  1040. </div>

  1041. </div>

  1042. </div>

  1043. <div class="row"><footer class="span12">

  1044.             Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>

  1045.             Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a12</a> and<br>

  1046.             generated on 2014-03-02T15:27:41Z.<br></footer></div>

  1047. </div>

  1048. </body>

  1049. </html>