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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

XDXGetPresentationProperties Function

Overview

The XDXGetPresentationProperties function returns the translated row/presentation flags in the form of properties from a row/info component or engram. The information specfies how the element/fact/row will be added to the eventual XBRL presentation.

Syntax/Parameters

Syntax

string = XDXGetPresentationProperties ( string data );

Parameters

data

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

Return Value

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

Remarks

The key names are as follows:

	Key Name		Description
	period_match_mode		Period match mode as a numeric string. See below.
	period_match_string		Period match mode as a descriptive string.
	indent		Nesting level for grouping, same as a visual indent.
	negated_role		Line item facts use negated role or negated state on a presentation.
	total_role		Line item facts use total role or total state on presentation.
	abstract_role		Line item specifies an abstract (no facts).
	date		Line item specifies a context date change.
	calculation		Line item is part of a calculation. See below.
	main_presentation		Exception to force on to summary or level 1 presentation.
	relation_code		See below.
	relation_string		See below.
	parent		Parent element if required,

 

Numeric string values and keywords are as follows:

	Definition			Value		String		Description
	Period Match
		XDX_ROW_PM_NONE		0		none		Not Defined (Duration)
		XDX_ROW_PM_INSTANT		1		instant		Instant
		XDX_ROW_PM_BEGINNING		2		beginning		Instant (Beginning Duration)
		XDX_ROW_PM_ENDING		3		ending		Instant (Ending Duration)
	Calculation Relations
		XDX_ROW_CALC_ADD		0		add		Adds
		XDX_ROW_CALC_SUB		1		subtract		Subtracts
		XDX_ROW_CALC_TOT		2		total		Totals
	Relationships
		XDX_ROW_POS_AUTO		0		auto		Auto (use indent)
		XDX_ROW_POS_CHILD		1		child		Child
		XDX_ROW_POS_BEFORE		2		before		Before
		XDX_ROW_POS_AFTER		3		after		After

 

Related Functions

XDXCreatePresentationComponent — Creates a property string containing presentation line item terms.

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.

XDXGetEngram — Gets an engram at a specific position.

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.