can_filter

LookML
Version

On this Page
Docs Menu

Go to Field Parameter List

Definition

The can_filter parameter enables you to prohibit a dimension or measure from being used as a filter. For example:

- dimension: description can_filter: false

The default value of can_filter is true, meaning that dimensions and measures can be used as filters as you would expect. However, there may be some cases when a field may be too demanding to search (like a large text description), and in these situations you can prevent that field from being used as a filter. Users will simply not see a FILTER option when they hover over the field.

Please note that can_filter cannot be used with:

  • type: list measures, because they cannot be filtered on anyway
  • filter fields, which only exist for the purpose of filtering
  • the filters parameter that is used with measures

Additionally, drilling (see drill_fields) will not be permitted if a can_filter dimension would be required in the drill. This occurs when:

  • Attempting to drill on a dimension that uses can_filter: false
  • Attempting to drill on a measure if a can_filter: false dimension is used in the same query as that measure
Still have questions?
Go to Discourse - or - Email Support
Top