Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter Twenty-threeXBRL Functions (continued)

XBRLViewGetLineItemLabel Function

Overview

The XBRLViewGetLineItemLabel function returns the label for a specific line item on a specific presentation.

Syntax/Parameters

Syntax

string = XBRLViewGetLineItemLabel ( handle hXBRL, int presentation, int line );

Parameters

hXBRL

A handle containing the reference to an XBRL Object.

presentation

A zero-based int specifying the presentation to reference for the line item.

line

A zero-based int specifying the line (row) index from which to retrieve the data.

Return Value

A string containing the label for the line item or an empty string on error. Use the GetLastError function to retrieve a formatted error code.

Remarks

The XBRLViewGetLineItemLabel function retrieves the label text for a specified line item index. The label can be empty which usually indicates the row entry is empty.

Rows can contain invalid labels or labels that do not have tags associated with the text. In these cases, the intersecting data on the presentation is not linked to an XBRL fact.

The label role is not presented in this mode. XBRL View will assign a role on export.

Related Functions

Platform Support

GoFiler Complete, GoFiler Corporate, GoXBRL