xbrl.table

The xbrl.table module provides a Python API for the Table Linkbase 1.0 specification. This Python interface enables the user to navigate the table linkbase and access information from the table-related resources.

Enum Classes

class xbrl.table.AxisType

The xbrl.table.AxisType enumeration defines the axis type.

AxisType.X

The x-axis.

AxisType.Y

The y-axis.

AxisType.Z

The z-axis.

class xbrl.table.FormulaAxisType

The xbrl.table.FormulaAxisType enumeration defines the tree walk direction of a relationship node. See here for more details.

FormulaAxisType.CHILD

The tree walk should include all child nodes of the source node.

FormulaAxisType.CHILD_OR_SELF

The tree walk should include the source node itself and all its child nodes.

FormulaAxisType.DESCENDANT

The tree walk should include all descendant nodes of the source node up to specified number of generations.

FormulaAxisType.DESCENDANT_OR_SELF

The tree walk should include the source node itself and all descendant nodes up to specified number of generations.

FormulaAxisType.SIBLING

The tree walk should include all sibling nodes of the source node.

FormulaAxisType.SIBLING_OR_DESCENDANT

The tree walk should include all sibling and descendant nodes of the source node.

FormulaAxisType.SIBLING_OR_DESCENDANT_OR_SELF

The tree walk should include the source node and its sibling and descendant nodes.

FormulaAxisType.SIBLING_OR_SELF

The tree walk should include the source node itself and all its sibling nodes.

class xbrl.table.ParentChildOrder

The xbrl.table.ParentChildOrder enumeration defines the parent-child ordering which specifies the position of roll-up nodes within the parent structural node.

ParentChildOrder.CHILDREN_FIRST

The roll-up node must be the last child of the parent structural node.

ParentChildOrder.PARENT_FIRST

The roll-up node must be the first child of the parent structural node.