xbrl.LayoutHeaderCell¶
The LayoutHeaderCell class represents a header cell in the generated table.
Base class: xbrl.LayoutCell
-
class
xbrl.LayoutHeaderCell¶
Attributes¶
-
xbrl.LayoutCell.col Returns the table cell’s X coordinate.
-
xbrl.LayoutCell.col_span Returns the table cell’s span in the horizontal direction.
-
xbrl.LayoutHeaderCell.constraint_sets¶ Returns a generator object of tag to constraint set mappings. The untagged constraint set can be accessed with None as the key.
-
xbrl.LayoutHeaderCell.definition_node¶ Returns an
xbrl.DefinitionNodeResourceobject representing the orignial definition node resource in the table linkbase.
-
xbrl.LayoutCell.is_data Returns True if this table cell represents a data cell.
-
xbrl.LayoutCell.is_header Returns True if this table cell represents a header cell.
-
xbrl.LayoutHeaderCell.is_rollup¶ Returns True if the header cell represents a roll-up node (http://www.xbrl.org/specification/table-linkbase/pr-2013-12-18/table-linkbase-pr-2013-12-18.html#sec-roll-up-nodes).
-
xbrl.LayoutCell.is_span_start Returns True if this table cell is the top left cell within a spanned region. Also returns True if the table cell doesn’t have a span.
-
xbrl.LayoutHeaderCell.preferred_label_role¶ For header cells generated by a tree walk of the presentation linkbase, the preferredLabel value on the relationship leading to a given concept is returned. Otherwise None is returned.
-
xbrl.LayoutCell.row Returns the table cell’s Y coordinate.
-
xbrl.LayoutCell.row_span Returns the table cell’s span in the vertical direction.
-
xbrl.LayoutHeaderCell.tag_selectors¶ Returns a generator object of tag selectors (either directly specified or inherited).
Methods¶
-
xbrl.LayoutHeaderCell.constraint_set(tag=None)¶ Returns an
xbrl.ConstraintSetobject for the given tag, or None if no constraint set with the given tag was found. If the tag is None, the untagged constraint set is returned.
Special methods¶
__eq__, __ge__, __gt__, __le__, __lt__, __ne__