Class ListFilterModel<T>

constructor

• new ListFilterModel<T>(listModel: ListModel<T>): ListFilterModel<T>

  Type Parameters

  • T

  Parameters

  • listModel: ListModel<T>

  Returns ListFilterModel<T>

ReadonlylistModel

setFilter

• setFilter(
      ownerId: string,
      disableRefresh?: boolean,
      ...filters: unknown[],
  ): void

  Set the filter instructions for the specified owner custom element view model.

  See https://www.npmjs.com/package/odata-query for supported filter types.

  Parameters

  • ownerId: string

    The custom element view model that the filters belong to.

  • disableRefresh: boolean = false

    If true, the list will not be refreshed after applying the filter.

  • ...filters: unknown[]

    The filter instructions to use. If multiple instructions are specified, the AND operation is used.

  Returns void

  Example

  class CustomListFilter {
    \@bindable public model: ListFilterModel;
  
    private applyFilter() {
      // Disable this filter:
      this.model.setFilter(this);
  
      // Apply a single filter:
      this.model.setFilter(
        this,
        { Domain: { eq: 'example.com' } }
      );
  
      // Apply multiple filters with "AND":
      this.model.setFilter(
        this,
        { Domain: { eq: 'example.com' } },
        { User: { eq: 'testify' } }
      );
  
      // Apply multiple filters with "OR":
      this.model.setFilter(this, { or: [
        { Domain: { eq: 'example.com' } },
        { User: { eq: 'testify' } },
      ] });
    }
  }
  Copy