Caption (PQL)

Returns the caption for a member or level.

  • Returned Output: Text
  • Library: PQL \ Semantic \ String
  • Version: 2020.10.000
  • Compatibility: Pyramid Query Language (PQL) data sources

Syntax

Caption( <Member> )

or

Caption( <Level> )

Syntax Alternatives

<Member> .Caption()

or

<Level> .Caption()

* Click on the function's arguments above for more details on the input values.

Comments
  • The member or level need to be the represented by their unique name.
    • Level name should be in the syntax "[dimension].^.[hierarchy].^[level]".
  • The function can be used in either construct, When using the hierarchy, it assumes the current member .
  • For details on how to employ and use this function see the semantic calculation overview.
Different Function types
  • This function is like the MDX caption function.

Examples

This example returns the string "NEW YORK" from the member.

Caption([Customer].[State].[New York])

This example returns the string "2018-01-01" from the member.

[data].[dateKey].[1199145600000].caption

This example returns the string "State" from the level.

[Customer].^.[geo hierarichy].^[State].caption