  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Eleven — SGML Functions (continued)
Overview
The XBRLGetFacts function returns a fact table as processed with optional filters.
Syntax/Parameters
Syntax
string[][] = XBRLGetFacts ( handle hXM, [string filters[]], [dword nocase] );
Parameters
hXM
A handle to an XBRL Object containing instance data.
filters
An optional string array specifying option filters as match strings. Each string can contain wildcard characters. Missing filters are treated as all or “*”. If the filters parameter is not provided, all concepts are returned.
nocase
An optional dword, if set to TRUE forces all compares as case-insensitive. The default value is FALSE. This parameter can only be used if the filters parameter is provided.
Return Value
Returns a string table of fact properties or an empty array on failure. Use the GetLastError function to retrieve a formatted error code.
Remarks
Each matching item is placed in the resulting table as a row with named columns for each fact. The column employs the key names specified at Section 11.20.9 Instance — Facts.
The filters use the following key names (a subset of the returned column key names):
abstract — Concept Abstract (boolean: true/false or 0/1) (1)(3)
balance_type — Concept Balance Type (1)(3)
concept — Concept Name
concept_uri — Concept Namespace URI (3)
context_id — Context ID
data_type — Concept Data Type (1)(3)
date_a — Context Instant/Start Date (2)(3)
date_b — Context End Date (2)(3)
decimals — Decimals A single ‘*’ will filter out all facts without decimals specified.
dimensional — Context has dimensions (boolean: true/false or 0/1) (1)(3)
element — Fact Element QName
fact_id — Fact ID
language — Language (text only)
nil — Is Nilled (boolean: true/false or 0/1) (1)
nillable — Concept Nillable (boolean: true/false or 0/1) (1)(3)
period_type — Concept Period Type (1)(3)
precision — Fact Precision. A single ‘*’ will filter out all facts without a precision specified.
prefix — Prefix/Namespace
sub_group — Concept Substitution Group (1)(3)
unit_id — Unit ID (numeric)
(1) No wildcard, not case-sensitive.
(2) Not case-sensitive.
(3) Data will not be present unless the model has been post processed and a taxonomy applied.
The abstract filter is present as part of the concept properties. For properly formatted XBRL, there should never be a fact related to a concept that is abstract.
Boolean filters use a sloppy tester based on the IsTrue and IsFalse functions. If the filter is not present, it is not tested.
If there are no matching items, an empty array is returned.
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.