GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

XBRLGetFootnotesForFact Function

Overview

The XBRLGetFootnotesForFact function returns a list of all linked footnote properties based on a fact ID.

Syntax/Parameters

Syntax

string[][] = XBRLGetFootnotesForFact ( handle hXM, string id );

Parameters

hXM

A handle to an XBRL Object containing instance information.

id

A string specifying a fact ID to locate. Note that locators use HREF style references and as such the ID must be preceded with a ‘#’ character.

Return Value

Returns a string table of footnotes and properties or an empty array on failure. Use the GetLastError function to retrieve a formatted error code.

Remarks

Just because a fact has an ID does not mean there are footnotes associated. Depending on the generating software for the instance, IDs may be used for a number of purposes.

Footnotes are linked via the fact ID, a locator and one or more arc entries. Each arc in turn points to the actual footnote entry. The XBRLGetFootnotesForFact function wades through the data and returns all the footnotes that are linked via the specified fact ID. 

The list employs the key names specified at Section 11.20.12 Instance — Footnotes. In addition, key names are added to indicate the linked items. These are as follows: 

	Key Name			Description/Comment
	Locator Record:
		loc_index		The zero based index to the footnote locator array.
		loc_label		The label to the arc. This is the link from the locator to the arc.
	Arc Record
		arc_index		The zero based index to the footnote arc array.
		arc_order		A decimal number, can have a decimal point, that specifies the order of the notes when displaying.
		arc_to		The ID used to link the arc to an actual footnote record.
		arc_role		The XBRL role used for the arc. For most implementations this value will be the same. Some implementations use the role to indicate special information about the footnote or fact.

 

The returned table can be ordered in a number of ways. It is generally good practice to sort it by the arc_order key.

If there are XBRL coding errors, the last error message will contain additional information. Check the post process log for additional error information. Most of the errors are sifted out during the post process, if run. Arcs with errors are not returned in the data set. check the post process log for errors.

Related Functions

XBRLGetFootnoteArcs — Returns all footnote arcs.

XBRLGetFootnote — Returns all the properties associated for a specified footnote.

XBRLGetFootnoteLocators — Returns all footnote locators.

XBRLGetFootnoteCount — Returns the number of footnotes loaded.

XBRLGetFootnotes — Returns all the properties associated with all footnotes.

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 10/21/2024

© 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.