  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Eleven — SGML Functions (continued)
XBRLGetCalculationItems Function
Overview
The XBRLGetCalculationItems is a high level function which will enumerate a series of resolved calculation information for a specified group of concepts or all concepts.
Syntax/Parameters
Syntax
string[][] = XBRLGetCalculationItems ( handle hXM, [string concept] );
Parameters
hXM
A handle to an XBRL Object containing taxonomy information.
concept
An optional string specifying a group to enumerate.
Return Value
Returns a string table of a calculation items or an empty array on failure. Use the GetLastError function to retrieve a formatted error code.
Remarks
Calculation items are resolve records created during the XBRL post process and run via the XBRLPostProcess function. The calculation list is sorted by:
Title (as set by calculation link)
Role (as set by calculation link)
Group Concept (totals to)
Order
Item Concept (member item)
The column key names are as follows:
| Key Name | Description/Comment | ||||
| Item record | |||||
| title | Optional title of calculation role, repeated for each item in the group. | ||||
| role | Role URI of calculation, repeated for each item in the group. | ||||
| order | A floating point value as a string specifying the order of the item within the group. | ||||
| Calculation Member* | |||||
| group_prefix | QName prefix for group element. | ||||
| group_concept | QName concept name for group element. | ||||
| group_concept_pos | Concept index for group concept. | ||||
| item_prefix | QName prefix for item element. | ||||
| item_concept | QName concept name for item element. | ||||
| Item_concept_pos | Concept index for item concept. | ||||
| weight | The sign or weight of the item, “1” for ‘+’ and “-1” for ‘-’. | ||||
| Cross Linking | |||||
| link_x | Index to calculation link. | ||||
| arc_x | Index to calculation arc. † | ||||
| loc_from_x | Index to locator ‘from’ record. † | ||||
| loc_to_x | Index to locator ‘to’ record. † | ||||
| Control | |||||
| position | The zero based position within the calculation arc table. | ||||
| s_dx | Source file DTS index. String is “-1” if not from the DTS. | ||||
| s_lx | Source file linkbase index. String is “-1” if not from the Linkbase List. | ||||
| l_sx | X position in source linkbase file for the calculation link. † | ||||
| l_sy | Y position in source linkbase file for the calculation link. † | ||||
| a_sx | X position in source linkbase file for item arc. † | ||||
| a_sy | Y position in source linkbase file for item arc. † | ||||
| cal_flags | A string as a hexadecimal value for the status of the entry. | ||||
* These items will be empty or -1 if the record specifies a link without calculation content.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| Table of Contents | < < Previous | Next >> |
© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.