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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

XDXGetCalculationProperties Function

Overview

The XDXGetCalculationProperties function returns calculation properties extracted from a component or an engram.

Syntax/Parameters

Syntax

string = XDXGetCalculationProperties ( string data, [int position] );

Parameters

data

A string containing an engram or element component of an engram.

position

An optional int specify a calculation position from 1 to X within an engram. See Remarks below.

Return Value

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

If successful, the last error value will contain the number of calculation groups within an engram. For a component, the value will always be one.

Remarks

The key names are as follows:

	Definition		Description
	relationship_code		A numeric version of the relationship. See below.
	relationship_string		A string version of the relationship.
	id		An identifier for the calculation that is 4 digits long. All engrams that use the same calculation identifier will be part of a single calculation. If an engram is used for a concept that is in more than one calculation another set of weight and identifier parameters are added.

 

Relationship codes and strings

	Definition			Value		Keyword String		Description
	Calculation Relationship
		XDX_ROW_CALC_ADD		0		add		Adds
		XDX_ROW_CALC_SUB		1		subtract		Subtracts
		XDX_ROW_CALC_TOT		2		total		Totals

 

Some presentation element may have more than one associated calculation. When using an engram as a data source, the position parameter can be used to specify which calculation group to reference.

The reciprocal function is XDXCreateCalculationComponent.

Related Functions

XDXCreateCalculationComponent — Creates a property formatted calculation string for an engram.

XDXGetContextMember — Extracts a single member pair from a context array.

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

XDXGetDisplayProperties

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

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

XDXGetElement — Extracts an element from an engram or component.

XDXGetGroupingProperties — Extracts grouping properties from engram or component.

XDXGetPrecisionProperties — Extracts precision properties from engram or component.

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.