xbrl.table.layout.Table

An xbrl.table.layout.Table class represents a table in the layout model.

class xbrl.table.layout.Table

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

Attributes

xbrl.table.layout.Table.definition_table

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

xbrl.table.layout.Table.shape

Returns the dimensions of the layout table as a (x,y,z) tuple. Please note that the shape does not include any headers; it specifies only the dimensions of the cube of data cells.

xbrl.table.layout.Table.structural_table

Returns an xbrl.table.structural.Table object which represents the corresponding table in the structural model.

Methods

xbrl.table.layout.Table.axis(axis)

Returns an xbrl.table.layout.Axis object representing the layout table headers along the axis.

xbrl.table.layout.Table.cell(*args, **kargs)

Returns an xbrl.table.layout.Cell object representing a layout table cell for the given coordinate. The coordinate can be specified by x, y and z arguments or an iterable yielding 3 integer values. Raises an IndexError if the coordinate is out of bounds.

xbrl.table.layout.Table.contains_facts()

Returns True if the table contains non-empty cells with facts.

xbrl.table.layout.Table.contains_facts_in_zslice(int z)

Returns True if the table z slice contains non-empty cells with facts.

xbrl.table.layout.Table.is_empty()

Returns True if the table doesn’t contain any rows or columns.

Special methods

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