`xbrl.TableResource`¶

The TableResource class represents a table resource in the table linkbase (http://www.xbrl.org/specification/table-linkbase/pr-2013-12-18/table-linkbase-pr-2013-12-18.html#sec-tables).

Base class: xbrl.Resource

class xbrl.TableResource(DTS dts, Element elem)¶

Attributes¶

xbrl.Resource.element: Returns an xml.Element object representing the XML element in the extended link.

xbrl.Resource.id: Returns the id attribute value as a string, or None if the XML element doesn’t have an id attribute.

xbrl.Resource.labels: Returns a generator object of xbrl.LabelResource objects for each generic label that has an element-label (http://xbrl.org/arcrole/2008/element-label) relationship to this resource.

xbrl.TableResource.parentChildOrder¶

xbrl.Resource.references: Returns a generator object of xbrl.ReferenceResource objects for each generic reference that has an element-reference (http://xbrl.org/arcrole/2008/element-reference) relationship to this resource.

xbrl.Resource.role: Returns the xlink:role attribute value as a string, or None if the XML element doesn’t have an xlink:role attribute.

Methods¶

xbrl.TableResource.breakdowns(axis)¶

xbrl.TableResource.layout(Instance instance=None, **options)¶: Returns an xbrl.LayoutTableSet object representing the generated table set. If an error occurs during the resolution or layout process, an xbrl.:obj:`TableError` is raised.

xbrl.Resource.select_labels(label_role=None, link_role=None, lang=None): Returns a generator object of xbrl.LabelResource objects for each generic label that has an element-label relationship (http://xbrl.org/arcrole/2008/element-label) to this resource and also matches the given parameters.

xbrl.Resource.select_references(reference_role=None, link_role=None): Returns a generator object of xbrl.ReferenceResource objects for each generic reference that has an element-reference relationship (http://xbrl.org/arcrole/2008/element-reference) to this resource and also matches the given parameters.

Special methods¶

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