GetCurrentSelections - chart function

GetCurrentSelections() returns the current selections in the app.

If options are used, you will need to specify record_sep. To specify a new line, set record_sep to chr(13)&chr(10).

If all but two, or all but one, values, are selected, the format 'NOT x,y' or 'NOT y' will be used respectively. If you select all values and the count of all values is greater than max_values, the text ALL will be returned.

Syntax:  

GetCurrentSelections ([record_sep [, tag_sep [, value_sep [, max_values [, state_name]]]]])

Return data type: string

Arguments:  

Arguments Description
record_sep Separator to be put between field records. The default is <CR><LF> meaning a new line.
tag_sep Separator to be put between the field name tag and the field values. The default is ': '.
value_sep The separator to be put between field values. The default is ', '.
max_values The maximum number of field values to be individually listed. When a larger number of values is selected, the format 'x of y values' will be used instead. The default is 6.
state_name

The name of an alternate state that has been chosen for the specific visualization. Alternate states are set up in the Qlik Engine API. If the state_name argument is used, only the selections associated with the specified state name are taken into account.

Examples and results:  

The following example uses two fields loaded to different filter panes, one for First name name and one for Initials.

Examples Results

Given that John is selected in First name.

GetCurrentSelections ()

'First name: John'

Given that John and Peter are selected in First name.

GetCurrentSelections ()

'First name: John, Peter'

Given that John and Peter are selected in First name and JA is selected in Initials.

GetCurrentSelections ()

'First name: John, Peter

Initials: JA'

Given that John is selected in First name and JA is selected in Initials.

GetCurrentSelections ( chr(13)&chr(10) , ' = ' )

'First name = John

Initials = JA'

Given that you have selected all names except Sue in First name and no selections in Initials.

GetCurrentSelections (chr(13)&chr(10), '=', ',' ,3)

'First name=NOT Sue'

Data used in example:

Names:

LOAD * inline [

"First name"|"Last name"|Initials|"Has cellphone"

John|Anderson|JA|Yes

Sue|Brown|SB|Yes

Mark|Carr|MC |No

Peter|Devonshire|PD|No

Jane|Elliot|JE|Yes

Peter|Franc|PF|Yes ] (delimiter is '|');

Did this information help you?

Can you tell us why it did not help you and how we can improve it?

Thanks for helping us improve!