The Ref3D Object

class Ref3D(atuple)

Represents an absolute or relative 3-dimensional reference to a box of one or more cells.

  • New in version 0.6.0

The coords attribute is a tuple of the form:

(shtxlo, shtxhi, rowxlo, rowxhi, colxlo, colxhi)

where 0 <= thingxlo <= thingx < thingxhi.

Note that it is quite possible to have thingx > nthings; for example Print_Titles could have colxhi == 256 and/or rowxhi == 65536 irrespective of how many columns/rows are actually used in the worksheet. The caller will need to decide how to handle this situation. Keyword: IndexError :-)

The components of the coords attribute are also available as individual attributes: shtxlo, shtxhi, rowxlo, rowxhi, colxlo, and colxhi.

The relflags attribute is a 6-tuple of flags which indicate whether the corresponding (sheet|row|col)(lo|hi) is relative (1) or absolute (0).

Note that there is necessarily no information available as to what cell(s) the reference could possibly be relative to. The caller must decide what if any use to make of oREL operands. Note also that a partially relative reference may well be a typo.

For example, define name A1Z10 as $a$1:$z10 (missing $ after z) while the cursor is on cell Sheet3!A27.

The resulting Ref3D instance will have coords = (2, 3, 0, -16, 0, 26) and relflags = (0, 0, 0, 1, 0, 0).

So far, only one possibility of a sheet-relative component in a reference has been noticed: a 2D reference located in the “current sheet”.

This will appear as coords = (0, 1, ...) and relflags = (1, 1, ...).

Previous topic

The Operand Object

Next topic

The Rowinfo Object

This Page