diff options
Diffstat (limited to 'doc/python/orcus/cell.rst')
-rw-r--r-- | doc/python/orcus/cell.rst | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/python/orcus/cell.rst b/doc/python/orcus/cell.rst new file mode 100644 index 0000000..0143307 --- /dev/null +++ b/doc/python/orcus/cell.rst @@ -0,0 +1,31 @@ + +Cell +==== + +.. py:class:: orcus.Cell + + This class represents a single cell within a :py:class:`.Sheet` object. + + .. py:method:: get_formula_tokens + + :rtype: :py:class:`.FormulaTokens` + :return: an iterator object for a formula cell. + + Get an iterator object for formula tokens if the cell is a formula cell. + This method returns ``None`` for a non-formula cell. + + .. py:attribute:: type + :type: orcus.CellType + + Attribute specifying the type of this cell. + + .. py:attribute:: value + + Attribute containing the value of the cell. + + .. py:attribute:: formula + :type: str + + Attribute containing the formula string in case of a formula cell. This + value will be ``None`` for a non-formula cell. + |