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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

XDXGetGroupingProperties Function

Overview

The XDXGetGroupingProperties function extracts the grouping data from a component or engram.

Syntax/Parameters

Syntax

string[] = XDXGetGroupingProperties ( string data );

Parameters

data

A string containing an engram or the precision component of an engram.

Return Value

A string array containing two elements or an empty array on failure. Use the GetLastError function to retrieve a formatted error code and GetLastErrorMessage for additional detail.

Remarks

This function disassembles an XDX grouping component which describes part of an iXBRL continuation. Any engram with this parameter has additional content that is tagged elsewhere in the document using the XDX_GROUPING_PART engram type.

XDX component formatting for this parameter are as follows:

gGroupOrder

where:

	Group	An identifier for the grouping that is only letters with the exception of L1, L2, or L3 are allowable. All engrams that use the same grouping identifier will be part of a single group.
	Order	An optional order that describes the order of the parts of the continuation. If an order is not specified the order is assumed to be the order the engrams appear in the file.

Examples:

gL1

The contents of this engram are continued later as L1.

The returned value will be a two element array with the key names “id” and “order”, 0 and 1 respectively.

If the order is not present, the string value will be “-1”.

Related Functions

XDXCreateGroupingComponent — Creates a grouping component to be placed in an engram,

XDXEngramToParameters — Parses an engram and breaks it in to its constituent parameters.

XDXEngramToProperties — Parses an engram and returns the high-level associated XBRL properties.

XDXGetDisplayFlags — Extracts the display flags from an engram or component.

XDXGetDisplayProperties — Extracts the display properties from an engram or component.

XDXGetElement — Extracts an element from an engram or component.

XDXGetEngramCount — Returns the current count in the engram map.

XDXGetPresentationProperties — Extracts presentation formation for one or more facts from engram or component.

XDXPropertiesToEngram — Creates an engram based on the specified properties.

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.