xbrlUnit is a text function that returns information about an XBRL unit that has been defined within a grid. xbrlUnit is supported in a heading cell or text cell, but not in text objects. The function syntax are
<<xbrlUnit("InfoType")>> <<xbrlUnit(“GridName”, Column, Row, Page, “InfoType”)>>
where:
GridName is the name of the Grid with XBRL metadata.
Column is the column segment (design time) identifier within the grid.
Row is the row segment (design time) identifier within the grid.
Page is the page to be used within the grid. (This parameter is currently ignored because, presently, XBRL metadata can be assigned only within the two-dimensional grid basis (on a row or column). It is provided for future use and consistency with other text functions.)
InfoType is one of the following values.
entityIdentifier
entityScheme
entitySegment
unit
unit2
unitOperation
period
cwa
precision
scenario
Note: | The reference parameters will update when rows or columns are added or deleted from the grid. |
Note: | The “current” keyword is supported for the reference parameters (“GridName”, Row, Column, and Page). However, it must be used within a grid's text cell and/or custom heading (not supported in text objects). |
The following example inserts the unit description into the column heading for an XBRL unit:
<<xbrlUnit("unit")>>