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

Table of Contents	< < Previous	Next >>

 

Chapter Eleven — SGML Functions (continued)

iXBRLGetItemProperties Function

Overview

The iXBRLGetItemProperties function returns the properties of a specified item within an iXBRL map.

Syntax/Parameters

Syntax

string [] = iXBRLGetItemProperties ( handle hIX, int index );

Parameters

hIX

A handle to an Inline XBRL object.

index

An int specifying a zero-base index for the item to retrieve properties.

Return Value

Returns a string array of properties associated with the item or an empty array on failure. Use the GetLastError function to retrieve a formatted error code.

Remarks

Common properties (key names):

	Key Name			Description/Comment
	Position:
		o_sy o_sx o_ey_o_ex		Inline XBRL open tag position.
		c_sy c_sx c_ey_c_ex		Inline XBRL close tag position. Depending on the element, these values value be invalid.
	Item Characteristics:
		m_type		A string in hexadecimal format representing the item item and associated flags.
		f_type		A string in hexadecimal format representing the field type or token. The token will be a predefined value as specified in the DTD.

 

Non Fraction Items:

	Key Name			Description/Comment
	Position:
		d_sy d_sx d_ey_d_ex		The position of the data contained in the Inline XBRL.
		data		A copy of the actual data. For non-Fraction this will generally be formatted numeric values.
	Attributes:
		contextRef		Context reference ID.
		decimals		Number of decimal places.
		format		Dimension element name (namespace and element).
		id		Dimension label.
		name		XBRL taxonomy referenced concept/name.
		order		Order.
		precision		Precision of value.
		scale		Scale of value.
		sign		Sign of value.
		target		Target.
		tupleRef		Tuple reference (not used with EDGAR).
		unitRef		Units for fact.

 

Related Functions

iXBRLCreateObject — Creates an iXBRL object based on a specific file.

iXBRLGetItemCount — Returns the number of items in the map.

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.