Skip to main content

GetSelectedCount - chart function

GetSelectedCount() finds the number of selected (green) values in a field.

Syntax:  

GetSelectedCount (field_name [, include_excluded [, state_name]])

Return data type: integer

Information note

The colors used in the selection bar, and for each selection state, can be modified with a custom theme. If you are working with an app that uses a custom theme, you might notice that your selections do not display with the same colors that are described in the help topic.

Arguments:  

Arguments
Arguments Description
field_name The field containing the range of data to be measured.
include_excluded If set to True(), the count will include selected values, which are currently excluded by selections in other fields. If False or omitted, these values will not be included.
state_name

The name of an alternate state that has been chosen for the specific visualization. If the state_name argument is used, only the selections associated with the specified state name are taken into account.

For more information, see Using alternate states for comparative analysis.

The following table lists other functions that are related to this function.

Related functions
Function Interaction
GetStateCounts - chart function

Using GetStateCounts(), you can combine the calculation of the following counts using a single function call:

  • Count of selected included values.

  • Count of possible values.

  • Count of alternative values.

  • Count of excluded values, not including alternative and selected excluded values.

  • Count of selected excluded values.

GetPossibleCount - chart function Returns the count of possible values.
GetAlternativeCount - chart function Returns the count of alternative values.
GetSelectedCount - chart function Returns the count of excluded values, not including alternative and selected excluded values.

Examples and results:  

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

Examples and results
Examples Results

Given that John is selected in First name.

GetSelectedCount ([First name])

1 as one value is selected in First name.

Given that John is selected in First name.

GetSelectedCount ([Initials])

0 as no values are selected in Initials.

With no selections in First name, select all values in Initials and after that select the value Yes in Has cellphone.

GetSelectedCount ([Initials], True())

6. Although selections with Initials values of MC and PD have Has cellphone set to No, the result is still 6, because the argument include_excluded is set to True().

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 page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!