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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

XBRLGetReferences Function

Overview

The XBRLGetReferences function returns actual reference items present in the instance/taxonomy.

Syntax/Parameters

Syntax

string[][] = XBRLGetReferences ( handle hXM, [string concept] );

Parameters

hXM

A handle to an XBRL Object containing instance information.

concept

An optional string containing a concept name to filter the list by.

Return Value

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

Remarks

Reference items are center point to the reference data. The records as loaded from the taxonomy are not directly associated with concepts. After post processing, the locators and arcs are resolved and the concept name and position are added to the record.

The data list is sorted by concept name on post process, otherwise the records are in the order loaded. The concept parameter can only be used if the model has been post processed using the XBRLPostProcess function.

Reference data is the information attached to the reference item by f_data_index data item.

The column key names are as follows: 

	Key Name			Description/Comment
	Item Record:
		concept		Related concept name. If the model has not been post processed, this value will be an empty string.
		concept_pos		A decimal string value that specifies the record position in the concept list. This can be used for fast access to concept properties.
		label		The identifier for the reference item to one or more the reference arcs. This is the value the “to” points to in the arc.
		role		Optional role definition for the reference item. These can be the roles defined in the XBRL 2.1 specification or defined by the author.
		title		Optional title of reference.
		type		Type of reference.
		language		Optional language,
	Control
		f_data_index		A zero-based index to the first reference data item.
		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.
		o_sx†		Zero-based X position in source file.
		o_sy†		Zero-based Y position in source file.
		ref_cnt		Number of arc references.
		ri_flags		A string as a hexadecimal value for the status of the entry.

 

† This value is not presented in terse mode.  

If there is more than one reference link, there will be null records that delineate the break points in the list between reference links. the ri_flags column will have the XM_REFERENCE_NULL_RECORD bit set.†

The value of f_data_index key points to the first reference data item,.

Related Functions

XBRLGetReference — Returns the properties for a specified reference (reference item).

XBRLGetReferenceArcs — Returns all the reference arcs.

XBRLGetReferenceCount — Returns a count of all references.

XBRLGetReferenceData — Returns the data elements for a specified reference.

XBRLGetReferenceLink — Returns a specified reference link.

XBRLGetReferenceLinkCount — Returns the number of items in the reference link table.

XBRLGetReferenceLinks — Returns all the reference links.

XBRLGetReferenceLocators — Returns all reference locators.

XBRLSetOptions — Set processing, data and reporting options.

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.