GoFiler Legato Script Reference   Legato v 1.4j Application v 5.22b

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

XBRLGetCalculationArcs Function

Overview

The XBRLGetCalculationArcs function returns a table of defined calculation arcs for the loaded taxonomy and linkbases.

Syntax/Parameters

Syntax

string[][] = XBRLGetCalculationArcs ( handle hXM, [int index] );

Parameters

hXM

A handle to an XBRL Object containing taxonomy information.

index

An optional zero-based int specifying the start position index to return a group of arcs.

Return Value

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

Remarks

Arcs connect calculation to specific elements (resources). The entire table can be returned by not specifying an index parameter. If an index is specified, it is assumed to be the start of a link group in which case the function will return all arcs until a null record is reached.

The column key names are as follows: 

	Key Name			Description/Comment
	Arc Record:
		arcrole		The arcrole attribute.
		from		The from attribute label to the arc. This is the link from the locator to the arc.
		order		The order attribute. Decimal with two places.
		title		The tittle attribute.
		to		The to attribute as the label used to link the arc to an actual footnote record.
		weight		The weight attribute specifying a a + or - multiplier.
	Control
		position		The zero based position within the calculation arc table.
		link_x		Zero based position of the parent link record.
		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		Position in source file.
		o_sy		Position in source file.
		ref_cnt		Number of arc references.
		arc_flags		A string as a hexadecimal value for the status of the entry.

 

The arc table is grouped by the parent links and will have gaps for for each link segment as marked by null records as marked by the XM_ARC_NULL_RECORD flag.

Related Functions

XBRLGetCalculationArc — Returns a specified calculation arc record.

XBRLGetCalculationItem — Returns a calculation data item for a specified record.

XBRLGetCalculationItemCount — Returns the number defined calculations.

XBRLGetCalculationItems — Returns a calculation data item for a specified record.

XBRLGetCalculationLink — Returns the properties for a specified calculation link.

XBRLGetCalculationLinkCount — Returns the number of calculation links loaded.

XBRLGetCalculationLinks — Returns all calculation links.

XBRLGetCalculationLocators — Returns all calculation locators.

XBRLGetCalculationRoles — Returns the Roles and Titles for all calculations.

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 04/22/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.