ParameterToken.resolve Method
Resolves the token value and returns the current value for the current offset and displayType settings.
Parameters
- displayType
-
Type: TokenDisplayTypes
(optional) Override value for the display type, if desired.
Optional: True
- offset
-
Type: Number
(optional) Override value for the offset, if desired.
Optional: True
- hierarchyEntityId
-
Type: String
(optional) The ID of the time dimension to use to format the text for the token.
If specified, then the hierarchyUniqueName must also be specified.
Optional: True
- hierarchyUniqueName
-
Type: String
(optional) The hierarchy unique name of the hierarchy within the time dimension to use to format the text.
Must be specified if hierarchyEntityId is specified.
Optional: True
Return Value
Type: jQuery.Promise
ElementType: String
A promise object that is resolved when complete.
If successful, a String object is returned with the resolved value for this token and offset.