Skip to main content
insightsoftware Documentation insightsoftware Documentation
{%article.title%}
Published:
Was this article helpful?
0 out of 0 found this helpful

GetSymbolSortOption

Use this function to return the sort option of the specified symbol. The sort option is returned as a string. Review the following table for a summary of possible return values and their corresponding status.

Return Value

Description

ASCENDING

The symbol sorts the child symbols in ascending order.

DESCENDING

The symbol sorts the child symbols in descending order.

MANUAL

The symbol sorts the child symbols manually as specified by the symbol priorities.

Copy

Syntax

GetSymbolSortOption("dimension", "symName")        

where:

  • dimension is the name of the dimension that contains the symbol.
  • symName is the name of the symbol whose sort option is to be retrieved.
Copy

Syntax example

Set Variable symSortOption = GetSymbolSortOption("ACCOUNTS", "Trial_Balance")        
Published:

GetSymbolSortOption

Use this function to return the sort option of the specified symbol. The sort option is returned as a string. Review the following table for a summary of possible return values and their corresponding status.

Return Value

Description

ASCENDING

The symbol sorts the child symbols in ascending order.

DESCENDING

The symbol sorts the child symbols in descending order.

MANUAL

The symbol sorts the child symbols manually as specified by the symbol priorities.

Copy

Syntax

GetSymbolSortOption("dimension", "symName")        

where:

  • dimension is the name of the dimension that contains the symbol.
  • symName is the name of the symbol whose sort option is to be retrieved.
Copy

Syntax example

Set Variable symSortOption = GetSymbolSortOption("ACCOUNTS", "Trial_Balance")        
For an optimal Community experience, Please view on Desktop