Product Documentation

Select a Product:

Find Text:
Submit a question:

Not seeing an answer to a question you might have? You can ask it here and we'll try to update the documentation to address it. If you're making a feature request or reporting a problem, please create a support item for it, instead!


Auto-completion Filter

Purpose

This slicer lets you use autocompletion as part of searching for values in text fields. Autocompletion is a technology that lets the user write some letters within an identifier, word, code, phrase or other text, and the visual predicts one or more possible matches, as choices. If the intended match is shown, it can be easily selected to be included as a report filter. You can filter using multiple terms, use fuzzy matching, copy-and-paste to and from the slicer, see secondary measures in the lookup list, and much more. There are over 100 settings that control behavior and formatting. The slicer lets you filter efficiently, especially when dealing with identifiers, names, codes, and any text strings of modest length.

Data Bucket

The data requirements for the Auto-completion Filter include 4 bucket fields, listed here:

Field Type Description
Value Source Text The text that should be made available for searching. Suggested types of values include identifiers, names, locations, product codes, etc.
Secondary value (optional) Text or numeric Zero, one or many values that will be shown in the suggestion list, next to the primary value. This can be used to help the user identify a proper match. Formatting rules are covered by various 'Secondary' settings.
Sort Order (optional) Text or numeric An optional value that can sort the pick list (as a primary sort value, with the value source becoming a secondary sort field).
Additional Tool Tips (optional) Text or numeric Zero, one or many fields that can be included in tool tip display, when tool tips are present (i.e. on pill values).
Filter Default (optional) Text An optional scalar value that is used as the initial filter value. The value can contain multiple text strings separated by commas. The value is reapplied when it changes, such as through cross filtering. This supports use cases such as defaulting filters depending on the user, etc.

Settings

Presets
Field Default Description
Use Case None You can optionally select a preset rules configuration which matches a use case. Picking a preset will automatically set other settings. Every preset also enables Follow Report Theme and sets General Style to 'Native Slicer', so the visual blends with the page's built-in slicers. Settings that are affected include:
Preset Affected
Names (Single) Support Multiple = Disabled
Only Allow Exact = Enabled
Diacritic Neutral = Enabled
Ignore Non-alphanumeric = Enabled
Keep Whitespace = Enabled
Use Fuzzy = Enabled
Fuzzy Algorithm = Double-Metaphone
Expand Only if Contains = Enabled
Expand on Add = Enabled
Retain Characters = None
Names (Multiple) Support Multiple = Enabled
Only Allow Exact = Enabled
Diacritic Neutral = Enabled
Ignore Non-alphanumeric = Enabled
Keep Whitespace = Enabled
Use Fuzzy = Enabled
Fuzzy Algorithm = Double-Metaphone
Expand Only if Contains = Enabled
Expand on Add = Enabled
Retain Characters = None
Addresses (Single) Support Multiple = Disabled
Only Allow Exact = Enabled
Diacritic Neutral = Enabled
Ignore Non-alphanumeric = Disabled
Keep Whitespace = Enabled
Use Fuzzy = Enabled
Fuzzy Algorithm = Double-Metaphone
Expand Only if Contains = Enabled
Expand on Add = Enabled
Retain Characters = None
Addresses (Multiple) Support Multiple = Enabled
Only Allow Exact = Enabled
Diacritic Neutral = Enabled
Ignore Non-alphanumeric = Disabled
Keep Whitespace = Enabled
Use Fuzzy = Enabled
Fuzzy Algorithm = Double-Metaphone
Expand Only if Contains = Enabled
Expand on Add = Enabled
Retain Characters = None
EMails (Single) Support Multiple = Disabled
Only Allow Exact = Disabled
Diacritic Neutral = False
Ignore Non-alphanumeric = Enabled
Keep Whitespace = Disabled
Use Fuzzy = Disabled
Expand Only if Contains = Disabled
Expand on Add = Disabled
Retain Characters = @@ and .
EMails (Multiple) Support Multiple = Enabled
Only Allow Exact = Disabled
Diacritic Neutral = False
Ignore Non-alphanumeric = Enabled
Keep Whitespace = Disabled
Use Fuzzy = Disabled
Expand Only if Contains = Disabled
Expand on Add = Disabled
Retain Characters = @@ and .
Keywords (Single) Support Multiple = Disabled
Only Allow Exact = Enabled
Diacritic Neutral = Enabled
Ignore Non-alphanumeric = Disabled
Keep Whitespace = Disabled
Use Fuzzy = Disabled
Expand Only if Contains = Disabled
Expand on Add = Disabled
Retain Characters = None
Keywords (Multiple) Support Multiple = Enabled
Only Allow Exact = Enabled
Diacritic Neutral = Enabled
Ignore Non-alphanumeric = Disabled
Keep Whitespace = Disabled
Use Fuzzy = Disabled
Expand Only if Contains = Disabled
Expand on Add = Disabled
Retain Characters = None
Paths (Single) Support Multiple = Disabled
Only Allow Exact = Disabled
Diacritic Neutral = Disabled
Ignore Non-alphanumeric = Disabled
Keep Whitespace = Enabled
Use Fuzzy = Disabled
Expand Only if Contains = Disabled
Expand on Add = Disabled
Retain Characters = \ and / and .
Paths (Multiple) Support Multiple = Enabled
Only Allow Exact = Disabled
Diacritic Neutral = Disabled
Ignore Non-alphanumeric = Disabled
Keep Whitespace = Enabled
Use Fuzzy = Disabled
Expand Only if Contains = Disabled
Expand on Add = Disabled
Retain Characters = \ and / and .
Titles (Single) Support Multiple = Disabled
Only Allow Exact = Disabled
Diacritic Neutral = Enabled
Ignore Non-alphanumeric = Enabled
Keep Whitespace = Enabled
Use Fuzzy = Enabled
Fuzzy Algorithm = Double-Metaphone
Expand Only if Contains = Enabled
Expand on Add = Enabled
Retain Characters = None
Titles (Multiple) Support Multiple = Enabled
Only Allow Exact = Disabled
Diacritic Neutral = Enabled
Ignore Non-alphanumeric = Enabled
Keep Whitespace = Enabled
Use Fuzzy = Enabled
Fuzzy Algorithm = Double-Metaphone
Expand Only if Contains = Enabled
Expand on Add = Enabled
Retain Characters = None
Geographical (Single) Support Multiple = Disabled
Only Allow Exact = Disabled
Diacritic Neutral = Enabled
Ignore Non-alphanumeric = Enabled
Keep Whitespace = Disabled
Use Fuzzy = Enabled
Fuzzy Algorithm = Double-Metaphone
Expand Only if Contains = Enabled
Expand on Add = Enabled
Retain Characters = None
Geographical (Multiple) Support Multiple = Enabled
Only Allow Exact = Disabled
Diacritic Neutral = Enabled
Ignore Non-alphanumeric = Enabled
Keep Whitespace = Disabled
Use Fuzzy = Enabled
Fuzzy Algorithm = Double-Metaphone
Expand Only if Contains = Enabled
Expand on Add = Enabled
Retain Characters = None
Identifier/SKU (Single) Support Multiple = Disabled
Only Allow Exact = Disabled
Diacritic Neutral = Disabled
Ignore Non-alphanumeric = Disabled
Keep Whitespace = Disabled
Use Fuzzy = Disabled
Expand Only if Contains = Disabled
Expand on Add = Enabled
Retain Characters = None
Identifier/SKU (Multiple) Support Multiple = Enabled
Only Allow Exact = Disabled
Diacritic Neutral = Disabled
Ignore Non-alphanumeric = Disabled
Keep Whitespace = Disabled
Use Fuzzy = Disabled
Expand Only if Contains = Disabled
Expand on Add = Enabled
Retain Characters = None
(in 5.0)
Styling None You can optionally select a preset formatting configuration which matches a use case. Picking a preset will automatically set other settings. Every preset also enables Follow Report Theme and sets General Style to 'Native Slicer', so the visual blends with the page's built-in slicers. Settings that are affected include:
Preset Affected
Text, Normal List Style = Text
List Placement = Under Entry
Show Links = Disabled
Show Clear Button = Enabled
Show Add Button = If Multiple
Show Add All Button = Disabled
Show Get List Button = Disabled
Show Loading Message = Enabled
Show Counts = Enabled
Can Toggle Exact Matching = Disabled
Background Opacity = 100
Background Color = Default
Text, Compact List Style = Text Pop-up
List Placement = In-line
Show Links = Disabled
Show Clear Button = Disabled
Show Add Button = Disabled
Show Add All Button = Disabled
Show Get List Button = Disabled
Show Loading Message = Disabled
Show Counts = Disabled
Can Toggle Exact Matching = Disabled
Background Opacity = 100
Background Color = Default
Text, Button Options List Style = Text
List Placement = Under Entry
Show Links = Disabled
Show Clear Button = Enabled
Show Add Button = If Multiple
Show Add All Button = If Multiple
Show Get List Button = Enabled
Show Loading Message = Enabled
Show Counts = Disabled
Can Toggle Exact Matching = Enabled
Background Opacity = 100
Background Color = Default
Text, Link Options List Style = Text
List Placement = Under Entry
Show Links = Enabled
Show Clear Button = Enabled
Show Add Button = If Multiple
Show Add All Button = If Multiple
Show Get List Button = Enabled
Show Loading Message = Enabled
Show Counts = Disabled
Background Opacity = 100
Background Color = Default
Text, Overlay List Style = Text
List Placement = Under Entry
Show Links = Disabled
Show Clear Button = Enabled
Show Add Button = If Multiple
Show Add All Button = Disabled
Show Get List Button = Disabled
Show Loading Message = Enabled
Show Counts = Disabled
Can Toggle Exact Matching = Disabled
Background Opacity = 0
Background Color = Default
Pills, Normal List Style = Pills
List Placement = Under Entry
Show Links = Disabled
Show Clear Button = Enabled
Show Add Button = If Multiple
Show Add All Button = Disabled
Show Get List Button = Disabled
Show Loading Message = Enabled
Show Counts = Enabled
Can Toggle Exact Matching = Disabled
Background Opacity = 100
Background Color = Default
Pills, Button Options List Style = Pills
List Placement = Under Entry
Show Links = Disabled
Show Clear Button = Enabled
Show Add Button = If Multiple
Show Add All Button = If Multiple
Show Get List Button = Enabled
Show Loading Message = Enabled
Show Counts = Disabled
Can Toggle Exact Matching = Enabled
Background Opacity = 100
Background Color = Default
Pills, Link Options List Style = Pills
List Placement = Under Entry
Show Links = Enabled
Show Clear Button = Enabled
Show Add Button = If Multiple
Show Add All Button = If Multiple
Show Get List Button = Enabled
Show Loading Message = Enabled
Show Counts = Disabled
Background Opacity = 100
Background Color = Default
(in 5.0)

Data and Interaction
Field Default Description
Only Allow Exact Off When enabled, fundamental matching uses 'exact' instead of 'contains', as it relates to what is filtered out from the visual. This does not affect how pick-list choices are generated. Note that contains matching does not require use of wildcard characters. Exact matching also disallows adding partial matches from the autocomplete field to the filter area. Refer to the on-line documentation for more details about how this combines with other settings. (in 1.5)
Filter Mode Include Identifies the default behavior of the filter: either include matched items, or exclude matched items. If toggling is enabled, this can be changed by the user.
Load Behavior Fully Loaded: No Match, No Data Specifies the visual's behavior around data loading. Options include:
Setting Description
Fully Loaded; No Match, No Data The visual will not filter until all values are fully loaded, and if there are no matches, all data will be filtered out.
Fully Loaded; No Match, All Data The visual will not filter until all values are fully loaded, and if there are no matches, no data will be filtered out.
Live Filtering; No Match, No Data Filtering will be attempted even prior to all values being loaded, and if there are no matches, all data will be filtered out. May terminate loading before all items are loaded.
Live Filtering; No Match, All Data Filtering will be attempted even prior to all values being loaded, and if there are no matches, no data will be filtered out. May terminate loading before all items are loaded.
Must Select Off When enabled, the visual filters out everything until a value is entered. (in 4.3)
Matched plus Blanks Off When enabled, blank values will be included in matching by default. (Default does not include blanks, meaning only exact matches are used.)
Allow Filter Prefixes Off When enabled, filter terms can be prefixed with '+', '&' or '-' to identify 'union', 'intersect' and 'not include' operations, respectively. (Overrides the Filter Term Combining and Filter Mode settings.) (in 3.2)
Maximum to Filter 10000 Lets you control the maximum number of filtered items that the visual will allow. Using 1 implies a single match. Very large numbers can impact overall performance.
Support Multiple On When enabled, an area is shown which allows entry / display of one or more filter values (comma or line separated).
Include Current as Type On When enabled, entry in the autocomplete field effectively appends to the filter list, even prior to committing the value.
Selecting Auto-Adds On When enabled and using multiple values, picking an item from the suggestion list immediately appends it to the value list; when disabled, one still can elect to add it using the add button.
Enter Adds Single On When enabled, the Enter key will add the entire match value when there's a single match, or there's a full match that's been autocompleted. When disabled, will only add the typed portion of text in the filter area.
Expand on Add Off When enabled, adding a term that matches values will add the matched values to the filter list, instead of the filter term.
Expand Only if Contains Off When enabled, 'expand on add' will only add items which actually contain the entered text. This is primarily useful when fuzzy matching is enabled. (in 2.0)
Allow CSV Entry Off When enabled, you can enter comma-separated values in the main entry field and 'adding' will split these into filter terms.
Keep List Open Off When enabled and multiple values allowed, the pick list can remain 'open' to allow for multiple selections (closes when focus changes); effectively invokes the 'get list' button functionality after a selection is made. (in 1.5)
Retain Partial Match on Add Off When enabled and multiple values allowed, the entered portion (when not a full match) is not cleared on an Add (either Enter, Add button or picking from list). Does not apply to 'expand on add'. (in 1.5)
Add Invalid Expand Off When enabled, adding a term that does not match any values will still add the term to the filter list. Otherwise, it will be disallowed silently. (in 4.1)
Attempt Completion On When enabled, as you type, a possible best match may be filled in but you can continue to type a different value.
Backspace Can Trigger Off When this is enabled and with Attempt Completion enabled, the Backspace key can increase the characters selected (for completion), instead of clearing them; when disabled, the behavior is closer to a traditional text input.
Matches Favor Prefer Early Matches With multiple matches, controls which matches are shown first in the autocompletion list. Early refers to matches close to the start of the source value; late refers to matches close to the end of the source value.
Matches Shown 10 The number of possible matches shown in the autocomplete pick list.
Auto-detect Minimum Characters On When enabled, the minimum number of characters required for search terms is determined based on your source data. When disabled, the minimum characters setting is used instead.
Minimum Characters 3 When auto-detect is disabled, this is the minimum number of characters required before matching is attempted. If this number is too small, performance can be negatively impacted.
Maximum Text Length 150 The default of 150 maximum characters can be changed using this setting. Strings longer than this are ignored from the filter and messaging indicates when this happens. Keep in mind: larger values here could negatively impact performance, so evaluate with your dataset. Also, you can suppress this messaging by removing the 'text too long' message text under Formatting. (in 1.6)
Always Show List On When enabled (the default), will always try to show a match list, even if fewer than the minimum number of characters are entered, for filtering. Keep in mind: filtering can't be applied until the minimum number of characters are supplied, and the 'too short' message will be shown when enabled.
List Sort Direction Ascending Controls the sort direction, when a sort is applied to the pick list data. (Applied to any explicit sort field, otherwise the primary value.)
Sort Precedence Match Favors / Explicit Sort / Value Controls the sort rules in the face of possible 'match favors' rules and explicit sort values (if provided). 'Match Favors' refers to the Match Favor setting, where one can prefer early or late matches.
In version 2.0, added the 'Explicit Sort / Match Favors / Distance / Value' option. (in 1.4)
Maximum Values for Sorting 5000 The maximum number of values that can be used for sorting purposes, for the pick list, prior to the entry of minimum characters. (Picking too large of a value can negatively impact performance.)
Filter Term Combining Union Normally, filter list items are combined (OR'ed), but this option lets you change that behavior to require all terms to match the source value (intersect). If 'Only Allow Matched' is true, this setting will always be treated as 'Union'. (in 2.6)
Word Splitting Disabled Controls if/how search terms can be split into word fragments and compared to source values. Intersect means all words must be present for a match. Union means any word must be present for a match. (in 1.5)
List Item Matching Whole Term Controls whether the whole filter list item is used for matching (default), or only a portion of it is. This allows one to paste in text that contains extra information that can be ignored for the purpose of matching. (in 2.6)
List Item Delimiter When 'List Item Matching' is set to use a custom delimiter, this is the custom delimiter text to use. (in 2.6)
Casing Auto-detect Specifies how casing is handled by the visual, such as if values typed by the user are forced upper or lower case. Options include:
Setting Description
Auto-detect If the loaded source values only contain upper-case values and no lower-case, then upper-case is assumed. If it only contains lower-case and no upper-case, then lower-case is assumed. Otherwise "original casing" is applied.
No Change The visual will not change the user's input.
Upper-case User entered values will all be forced to upper-case.
Lower-case User entered values will all be forced to lower-case.
Case Must Match Off When disabled, case is not required to match.
Can Change Case On When enabled, the your typed text can be changed to match the case of the corresponding matched source value. (in 1.4)
Ignore Non-alphanumeric On When enabled, allows you to skip entry of non-alphanumeric values such as dashes, spaces, etc.
Keep Whitespace Off When enabled, whitespace in the search term must match whitespace in the source data (regardless of 'Ignore Non-alphanumeric' setting). (in 1.4)
Retain Characters You can specifically override 'Ignore Non-alphanumeric' (when enabled) to list characters that should NOT be excluded from matching. For example '@' might be considered important for email lookups. No delimiters are required: all characters in the string are retained for matching. (in 2.7)
Diacritic Neutral Off When enabled, internally converts diacritic (accented) characters to ASCII characters, for comparison purposes. This makes data entry somewhat more 'forgiving,' primarily in English locales.
Blank Lookup Text When provided, this value gets added to the list of possible lookup values (if there is at least one blank value), but when it's selected, it will match blank values (only), including empty strings. Be sure this never matches values in source data, since it takes precedence in this setting. Example: N/A (in 2.7)
Value Separator - When multiple fields are provided in the Value Source bucket, their values are joined with this separator to form the lookup string. Selecting a combined value filters the underlying rows across all provided columns.
Up to 4 fields can be provided in the Value Source well, all from the same table. All matching behavior (autocomplete, exact/contains, fuzzy, batch expansion) operates against the combined string. Selections filter the underlying rows across all provided columns (a Power BI tuple filter). Note: exclude mode is not supported with multiple value fields; a warning is shown and the filter is not applied until include mode is restored. Choose a separator that does not occur inside your data values to keep combined entries unambiguous. (in 5.2)
Fuzzy Matching Off When enabled, similar text matches are allowed, based on fuzzy matching rules. This is most useful when dealing with whole words, versus codes and identifiers. This makes data entry more forgiving in the face of spelling differences, primarily in English locales.
Fuzzy Algorithm Standard Controls what algorithm is used for fuzzy matching. Default is the "Standard" algorithm (the only one available pre-2.0). Options include:
Setting Description
Standard Applies a number of transformations on text to eliminate a number of common misspellings (typical of English). More focused on spelling errors than on phonetic similarity (metaphone) or context (lemmatization).
Custom Mapping When this is selected, the "Fuzzy Custom Map" setting is used. The visual user can specify their own custom mappings which transform input text into a normalized term. For example, 'ei;ie' would change occurrences of 'ei' to 'ie' for the purposes of searching/matching. In this example, if someone misspelled "receive" as "recieve", both word forms would transform to the same underlying value, allowing matching to "work". Notice it's not important that the transformed word is spelled incorrectly: the important thing is it is that all possible forms are mapped to the same target form.
Lemmatized The source terms are transformed into base terms, where simple lemmatization rules are applied. This can allow matching when words are provided which are similar, but may differ based on their inflected forms.
Double-metaphone The source terms are transformed into base terms based on the rules of the double-metaphone algorithm. This attempts to allow words that sound similar to match.
Lemmatized + Double-metaphone This algorithm combines the rules of both "lemmatized" and "double-metaphone".
(in 2.0)
Fuzzy Custom Map When the fuzzy matching algorithm is set to 'custom mapping', this field lets you specify character translations, one per line. Each translation should be of the form 'from;to' where the text 'from' is treated as if 'to' for the purposes of matching.
For example, "ei;ie" would change occurrences of "ei" to "ie" for the purposes of searching/matching. In this example, if someone misspelled "receive" as "recieve", both word forms would transform to the same underlying value, allowing matching to "work". Notice it's not important that the transformed word is spelled incorrectly: the important thing is it is that all possible forms are mapped to the same target form. The mapping is case-insensitive. The mapping is applied to the source data, and to the entered text, so that the entered text is transformed before matching. (in 2.0)
Maximum Lexical Distance When set, causes possible matches that are 'further' away from the input text than this lexical distance to be excluded. Similar to Levenshtein distance, but penalizes extra characters less. Relevant when using fuzzy matching algorithms such as double-metaphone. (in 2.0)
List Not Fuzzy On When enabled (default), items collected in the multi-select list (or completed in single select) do not 'filter out' using fuzzy matching rules (i.e. the 'Only Allow Exact' setting is considered for exact vs. contains matching). If fuzzy matching is enabled, it only pertains to the lookup list, effectively. When not enabled, each entry can match out based on its own fuzzy matching rules. (in 2.0)
Single-Word Token Match in Exact Off When enabled (and Only Allow Exact is on, and Fuzzy Matching is on), a single-word filter list entry expands to every source value where the word appears as a complete token (e.g. typing 'Hollywood' matches every 'Hollywood Blvd'-style value). Expansion is capped by Maximum to Filter. Multi-word filter list entries still require an exact match - typing '6 Hollywood Blvd' will NOT match 'Old 6 Hollywood Blvd Apt 1'. Only affects how filter list items resolve to source values; the autocomplete pick list remains liberally fuzzy regardless. (in 5.1)
Persist Values On When enabled, filter values that are set in edit mode are preserved when the report is saved, otherwise the visual always starts with no filter.
Maximum Cache (seconds) 0 The maximum number of seconds that the visual can continue to hold cached value data, before any external refresh or filter change will trigger a reload. Longer values improve performance at the expense of data currency. A nonzero value can 'see through' filters that may be applied externally by the report, and the reset button can be used to release cached values manually.
Secondary Aggregation Sum/Concatenate When using secondary values, controls how to handle cases where multiple secondary values apply to a single primary value.
Use Default Context Menus Off When enabled, context menus on text controls will be the browser default as opposed to the Power BI context menu. This gives you the option to use browser menu features (eg. copy, paste). (in 1.5)
Allow Tooltips On When enabled, tool-tips may be shown when hovering on pills that have secondary values to show.
Allow Pill Drill-through Off When enabled, pills which correspond to 'exact matches' in the source data expose a context menu in a way that supports drill-through. Enabling this may have a significantly negative impact on performance - you should only use this when pre-filtering data, and there is a limit to 10000 rows where this may be applied.

Formatting
Field Default Description
General Style Base Default Offers some different general styles for the visual.
In version 5.2, added the 'Native Slicer' option: the entry areas get a thin border with slight rounding and the buttons become flat, matching the look of the built-in Power BI slicers. The border color is inherited from the current report theme (like standard visuals) so it blends with sibling slicers; set an explicit 'Entry Border Color' to override it. To tighten the visual against its frame, reduce the 'Container Padding' setting. (in 1.7)
List Placement Under Entry Controls where the pick list is positioned. The default is under the entry text field. In-line allows the list to overlap the entry field, following the caret. Far right places it to the right of the entry field. (in 2.5)
List Formatting Line-feeds Controls the formatting of terms in the text area, when using the Text style.
List Style Text When supporting multiple values for filtering, determines the style of the multiple filter values. ('Text Pop-up' hides the filter list until it's activated.)
Show Links Off When enabled, links will be used instead of buttons. Links will use the Message: settings for the text to display. (in 2.4)
Can Toggle List Style Off When enabled, a button is available that lets the user toggle the list style (when supporting multiple values).
Can Toggle Show Blanks Off When enabled, a button is available that lets the user toggle the inclusion of blank values.
Can Toggle Exact Matching Off When enabled, a button is available that lets the user toggle between exact or contains matching modes. (in 5.0)
Can Toggle Include Exclude Off When enabled, a button is available that lets the user toggle whether the visual is including or excluding matched values.
Filter Word Wrap On When enabled, word-break word wrapping will be used for the filter area. (in 1.6)
Resize Filter to Content Off When enabled, the visual height dictates a maximum height, where the filter area can be made smaller dynamically, to fit its content. (in 1.6)
Show Add Button On When disabled, the add button will be hidden (Enter key can still be used).
Show Add All Button Off When disabled, the add all button will be hidden.
Show Expand-Batch-with-Mappings Button Off When enabled, a button is shown that takes every value in the filter list and expands each into its matching source values. The filter list is replaced with the union of all expansions, and a mapping table (matched value, originating term) is copied to the clipboard. Useful both for batch-expanding a list of terms and for auditing how each search term mapped to source values. (in 5.1)
Expand-Batch-with-Mappings Delimiter \\t Delimiter placed between the matched value and the originating term in the mapping table copied to the clipboard. Default is a tab character (paste-friendly for Excel). Use \\t for tab. (in 5.1)
Show Clear Button On When disabled, the clear button will be hidden.
Show Get List Button Off When disabled, the 'force show list' button will be hidden. (in 1.5)
Show Copy Clipboard Off When disabled, the copy to clipboard button will be hidden. Note: copy functionality varies based on browser used. (in 2.0)
Show Cancel Load Off When disabled, the cancel load button will always be hidden. (in 4.0)
Show Loading Message On When enabled, the loading message will be shown below the value entry control.
Loading Indicator Style Text Choose how the loading indicator appears. 'None' hides it. 'Text' shows the 'Loading...' message below the entry control (default - matches prior behavior). 'Spinner' replaces the text with a centered spinner overlaid on the visual. The Show Loading Message setting must also be enabled for the indicator to appear. (in 5.1)
Show Counts On When enabled, rows loaded and matched counts are shown.
Show Close List Link Off When enabled, the drop-list includes an extra item - a link - for 'close' (of the list). (in 2.0)
Filter Text Read Only Off When enabled, the filter text area will be read-only. (in 1.5)
Secondary Style Use Delimiter and Parentheses Controls general format rules for secondary values. For example, multiple secondary values can be concatenated with a delimiter, or a format string can be used, instead. Format string rules are documented in on-line help. (in 3.0)
Secondary: Delimiter If multiple secondary values are present, identifies what delimiter would be used to separate them. (in 3.0)
Secondary: Format String ({0}) This allows you to control placement of all secondary values, with any desired additional literal text. Secondary values are substituted into the string where {0} represents the first value, {1} the second value, and so on. (in 3.0)
Secondary Formatting (First) Auto Controls the formatting of only the first of any secondary values you provide. (Anything past the first will use 'Auto'.) Note: 'Auto' will use semantic model formatting for the value.
Secondary: Currency Code If the secondary value should be shown as a currency, indicates the currency type, in ISO 4217 currency code format (eg. USD).
Secondary Max Decimal 2 For secondary values that are numbers, specifies the maximum number of decimal places.
Secondary Min Decimal 0 For secondary values that are numbers, specifies the minimum number of decimal places.
Secondary Labels from Model Off When enabled, labels will be appended to all secondary values, with the label text coming from the field name, as shown in the visual's secondary values well. (in 3.0)
Secondary Label Optional text that can prefix all secondary values in the pick-list.
Entry Text Size 12 The size of the entry and filter text.
Entry Font The font family for the entry text.
Filter Text Size 10.5 The size of the text in pills and in the filter text area.
Filter Font The font family for the text in pills and in the filter text area.
List Text Size 10.5 The size of the text in the suggestion list.
List Text Font The font family for the text in the suggestion list.
Links Text Size The size of the text used for links, when the 'show as links' setting is enabled. (in 2.4)
Links Text Font The font family for links, when the 'show as links' setting is enabled. (in 2.4)
Counter Text Size The size of the counter text. (in 2.1)
Counter Text Font The font family for the counter text. (in 2.1)
Status Text Size The size of the status message text font. (in 3.3)
Status Text Font The font family for the status message text. (in 3.3)
Loading Text Loading Text to show for the 'Loading' message.
Loaded Text loaded Text to show for the 'loaded' count text.
Matched Text matched Text to show for the 'matched' count text.
Filtered Text filtered Text to show for the 'filtered' count text.
Filtered Out Text filtered out Text to show for the 'filtered out' count text.
Various Message Text Overrides You can change the text shown for various messages, such as when the user tries to add a value that is too short, or when the user tries to add a value that is not an exact match. The text can include placeholders for values, such as {0} or {1}. The placeholders will be replaced with the appropriate values at runtime.
Message: Exclude Mode Unsupported Exclude mode is not supported with multiple value fields. Switch to include mode to apply the filter. Text to show when exclude mode is used with multiple Value Source fields (not supported by Power BI tuple filters). (in 5.2)
Message: Fields Span Tables All value fields must come from the same table. Remove fields from other tables. Text to show when Value Source fields come from different tables (multi-field filtering requires a single table). (in 5.2)
Various Tool Tip Overrides You can override the text shown for different tool tips, most of which are shown when hovering over buttons.
Message: Expand Batch with Mappings Expand Batch with Mappings Text to show for the Expand-Batch-with-Mappings tool tip. (in 5.1)
Image: Reset An optional override for the image to use for the reset button. The image must be in base64 encoded format (prefixed with 'data:image/png;base64' for example). See https://www.base64-image.de (in 2.6)
Image: Add An optional override for the image to use for the add button. The image must be in base64 encoded format (prefixed with 'data:image/png;base64' for example). See https://www.base64-image.de (in 2.6)
Image: Append All An optional override for the image to use for the append all button. The image must be in base64 encoded format (prefixed with 'data:image/png;base64' for example). See https://www.base64-image.de (in 2.6)
Image: Expand Batch with Mappings An optional override for the image to use for the expand-with-mappings button. The image must be in base64 encoded format (prefixed with 'data:image/png;base64' for example). See https://www.base64-image.de (in 5.1)
Image: Bullet Style An optional override for the image to use for the bullet style button. The image must be in base64 encoded format (prefixed with 'data:image/png;base64' for example). See https://www.base64-image.de (in 2.6)
Image: Text Style An optional override for the image to use for the text style button. The image must be in base64 encoded format (prefixed with 'data:image/png;base64' for example). See https://www.base64-image.de (in 2.6)
Image: Copy An optional override for the image to use for the copy button. The image must be in base64 encoded format (prefixed with 'data:image/png;base64' for example). See https://www.base64-image.de (in 2.6)
Image: Delete An optional override for the image to use for the delete button (red X). The image must be in base64 encoded format (prefixed with 'data:image/png;base64' for example). See https://www.base64-image.de (in 2.6)
Image: Down An optional override for the image to use for the down (arrow) button. The image must be in base64 encoded format (prefixed with 'data:image/png;base64' for example). See https://www.base64-image.de (in 2.6)
Image: Include An optional override for the image to use for the include button. The image must be in base64 encoded format (prefixed with 'data:image/png;base64' for example). See https://www.base64-image.de (in 2.6)
Image: Exclude An optional override for the image to use for the exclude button. The image must be in base64 encoded format (prefixed with 'data:image/png;base64' for example). See https://www.base64-image.de (in 2.6)
Image: Hide An optional override for the image to use for the hide button. The image must be in base64 encoded format (prefixed with 'data:image/png;base64' for example). See https://www.base64-image.de (in 2.6)
Image: Show An optional override for the image to use for the show button. The image must be in base64 encoded format (prefixed with 'data:image/png;base64' for example). See https://www.base64-image.de (in 2.6)
Image: Contains An optional override for the image to use for the contains match button. The image must be in base64 encoded format (prefixed with 'data:image/png;base64' for example). See https://www.base64-image.de (in 5.0)
Image: Exact An optional override for the image to use for the exact match button. The image must be in base64 encoded format (prefixed with 'data:image/png;base64' for example). See https://www.base64-image.de (in 5.0)
Image: Popup An optional override for the image to use for show popup button. The image must be in base64 encoded format (prefixed with 'data:image/png;base64' for example). See https://www.base64-image.de (in 3.0)
Image: Popup Filtered An optional override for the image to use for show popup (filtered) button. The image must be in base64 encoded format (prefixed with 'data:image/png;base64' for example). See https://www.base64-image.de (in 3.0)
Image: Cancel Load An optional override for the image to use for the cancel load button. The image must be in base64 encoded format (prefixed with 'data:image/png;base64' for example). See https://www.base64-image.de (in 4.0)
Auto Localize On When enabled, many text strings / messages in the visual will be converted to the language determined by the browser, or if a value is provided in the 'Localize to Language' setting, that language code will be used explicitly. Only applies to default message strings. One can provide their own (localized) text though a number of settings (e.g. those with names starting with 'Message:'). (in 3.1)
Localize to Language When 'Auto Localize' is enabled, this setting can override the browser language. This should be the first 2 characters of a standard BCP 47 language code. (in 3.1)
Entry Minimum Width Allows for an explicit minimum width on the value entry control, in pixels.
Entry Minimum Width (%) Allows for an explicit minimum width on the value entry control, as a percentage of total width. (in 2.4)
Entry Maximum Width (%) Allows for an explicit maximum width on the value entry control, as a percentage of total width. Note: when using list placement to the right, 50% will be used for this setting unless set explicitly. (in 2.5)
Entry Text Height An optional height override for the entry text box. (0 = default height) (in 3.4)
Filter List Max Height Allows setting a maximum height for the filter list area (in pixels). Resize Filter to Content takes precedence. 0 is no limit. (in 4.3)
List Height Ratio 95 The suggested percentage of maximum space to use for the pick list maximum height. (in 1.4)
Copied Message Duration 4 The number of seconds to display the 'copied data to clipboard' message. Use zero to show no message. (in 2.4)
List Height Minimum Allows for an explicit minimum height of the autocomplete list, otherwise a default will be used (if unset or 0).
Container Padding 4 Padding (in pixels) around the visual's inner container. Also drives the entry row's horizontal padding (half of this value) and the entry control's padding.
Additional Inner Padding 0 Allows additional padding to be included between elements within the visual.
Bottom Padding 0 Allows additional padding that is applied at the bottom of the visual. This provides a way to build overlapping visuals which lets the pick list seemingly show outside of the visual's defined screen real estate. (See pbix sample.)
Placeholder Text Placeholder text to show in the autocompletion field until a user-entered value is provided.
Filter Placeholder Text Placeholder text to show in the filter list until a user-entered value is provided. (in 2.6)
Close List Text Close Text to show for the 'close' link, when 'Show Close List Link' is enabled. (in 2.0)

Colors
Field Default Description
Follow Report Theme Off When on, any color left unset below inherits from the current report theme (like standard visuals), so the visual blends with sibling visuals on the page. Explicit color choices always take precedence. High-contrast accessibility themes are always honored regardless of this setting. Selecting any Use-case or Styling preset turns this on. (in 5.2)
Text Color The color override for general text within the visual.
Status Message Color The color override for status message text. (in 3.3)
Background Color The background color for the visual's whitespace areas. Unset implies 'transparent' (starting in 5.0).
Background Opacity 0 The opacity (percentage) for the background color. (Zero is fully transparent and is the default, starting in 5.0.)
Entry Background Color The background color override for the text entry control.
Entry Border Color The border color for the visual's entry areas. (in 4.2)
Placeholder Text Color The color to use for placeholder text. (in 3.4)
List Background Color The background color override for the pick list area.
Filter Background Color The background color override for the filter text area.
Item Highlight Color The color override for the highlight color for matched text in items in the suggestion list.
Item Hover Color The color override for items in the suggestion list, when hovering.
Button Background Color The background color for buttons within the visual. (in 1.7)
Links Color The color override for the link text, when the 'show as links' setting is enabled. (in 2.4)
Pill Background Color The color override for the background color of pills, in the Pill display style.

Other Resources / Links:

AppSource Purchase Guide

Learn more about purchasing one or more user licenses from Microsoft AppSource.
This application may no longer respond until reloaded. Reload 🗙