xbrl.table.layout.AxisHeader

An xbrl.table.layout.AxisHeader class represents a header cell in an axis of a layout table.

class xbrl.table.layout.AxisHeader

Proper instances of this class will be created within RaptorXML only, instantiation from script code will throw a NotImplementedError exception.

Attributes

xbrl.table.layout.AxisHeader.axis

Returns an xbrl.table.layout.Axis object which represents the parent layout axis.

xbrl.table.layout.AxisHeader.children

Returns an iterator of xbrl.table.layout.AxisHeader objects which represent the child header cells spanned by this header cell.

xbrl.table.layout.AxisHeader.definition_node

Returns an xbrl.table.DefinitionNode object which represents the corresponding definition node in the definition model.

xbrl.table.layout.AxisHeader.last_rollup_descendent

Returns an xbrl.table.layout.AxisHeader object representing the last descendent roll-up header cell or None if this header cell does not have a roll-up child.

xbrl.table.layout.AxisHeader.non_rollup_ancestor

Returns an xbrl.table.layout.AxisHeader object representing the first ancestor header cell in the same (or spanned) slice that is not a roll-up node or None if there header cell is in the top row.

xbrl.table.layout.AxisHeader.non_rollup_ancestor_or_self

Returns an xbrl.table.layout.AxisHeader object representing either itself or the first ancestor header cell in the same (or spanned) slice that is not a roll-up node.

xbrl.table.layout.AxisHeader.parent

Returns an xbrl.table.layout.AxisHeader object representing the parent header cell in the same (or spanned) slice or None if there header cell is in the top row.

xbrl.table.layout.AxisHeader.pos

Returns the coordinate for this header cell on the axis as a (slice,row) tuple.

xbrl.table.layout.AxisHeader.rollup_child

Returns an xbrl.table.layout.AxisHeader object representing the roll-up child header cell or None if this header cell does not have a roll-up child.

xbrl.table.layout.AxisHeader.row

Returns the corresponding row coordinate for this header cell on the axis.

xbrl.table.layout.AxisHeader.slice

Returns the corresponding slice (column) coordinate for this header cell on the axis.

xbrl.table.layout.AxisHeader.span

Returns the number of cells spanned by this header cell.

xbrl.table.layout.AxisHeader.structural_node

Returns an xbrl.table.structural.Node objects which represent the corresponding strucutral node in the structural model.

xbrl.table.layout.AxisHeader.table

Returns an xbrl.table.layout.Table object which represents the parent layout table.

Methods

xbrl.table.layout.AxisHeader.is_rollup()

Returns True if this header cell is a roll-up node.

Special methods

__bool__, __eq__, __ge__, __gt__, __le__, __lt__, __ne__