Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter Twenty-threeXBRL Functions (continued)

XBRLViewGetElements Function

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