GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
Table of Contents | < < Previous | Next >> |
Chapter Twenty-three — XBRL Functions (continued)
Overview
The XBRLViewGetElements function retrieves all the elements within an XBRL Object in the form of a string array. Enumeration can be filtered by certain element characteristics.
Syntax/Parameters
Syntax
string[] = XBRLViewGetElements ( handle hXBRL, [string datatype, [string period,
[string
balance, [string location ]]] );
Parameters
hXBRL
A handle containing the reference to an XBRL Object.
datatype
An optional string specifying a data type filter. This value is a string representation of the XBRL standard data types, the string must have the trailing ‘:’ for the namespace. For example, “us-types:”.
period
An optional string specifying a period type filter. The types are: “Implied”, “Instant” and “Duration”. If not supplied, elements of all period types are returned.
balance
An optional string specifying a balance type filter. The types are: “Debit”, “Credit” and “None”. If not supplied, elements of all balance types are returned.
location
An optional string specifying a location type filter. The types are: “Auto”, “Extension” and “Defined”. If not supplied, elements of all types are returned. The “Defined” type means the element is part of a predefined taxonomy.
Return Value
A string array containing the element names for the XBRL Object or an empty set on failure. Generally, an XBRL Object should have one or more elements. Use the GetLastError function to retrieve a formatted error code.
Remarks
The array is always sorted ascending by string (namespace and element).
This list includes all elements including ‘nonnum’ types.
Related Functions
Platform Support
GoFiler Complete, GoFiler Corporate, GoXBRL
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.