insert-formula.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="vtiful-kernel-excel.insertFormula" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>Vtiful\Kernel\Excel::insertFormula</refname>
  <refpurpose>Vtiful\Kernel\Excel insertFormula</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <methodname>Vtiful\Kernel\Excel::insertFormula</methodname>
   <methodparam><type>int</type><parameter>row</parameter></methodparam>
   <methodparam><type>int</type><parameter>column</parameter></methodparam>
   <methodparam><type>string</type><parameter>formula</parameter></methodparam>
  </methodsynopsis>
  <para>
    Insert calculation formula.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>row</parameter></term>
    <listitem>
     <para>
      cell row
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>column</parameter></term>
    <listitem>
     <para>
      cell column
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>formula</parameter></term>
    <listitem>
     <para>
      formula string
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <classname>Vtiful\Kernel\Excel</classname> instance
  </para>
 </refsect1>

<refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>example</title>
   <programlisting role="php">
<![CDATA[
<?php
$config = [
    'path' => './tests'
];

$excel = new \Vtiful\Kernel\Excel($config);

$file = $excel->fileName("free.xlsx")
    ->header(['name', 'money']);

for($index = 1; $index < 10; $index++) {
    $file->insertText($index, 0, 'viest');
    $file->insertText($index, 1, 10);
}

$file->insertText(12, 0, "Total");
$file->insertFormula(12, 1, '=SUM(B2:B11)'); // insert formula

$file->output();
]]>
   </programlisting>
  </example>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->