List Filter Online for SharePoint: Features and Configuration

5/12/2024
Applicable to: List Filter Online
Environments: SharePoint Online

The Vitextra List Filter Online web part lets users filter and retrieve data from a SharePoint list or document library. This article describes the web part's main features and how to configure it.

Web Part Overview

The List Filter Online web part helps users quickly find the information they need in SharePoint lists and document libraries. It provides a flexible filtering system that narrows results by criteria such as date, author, or content, and its intuitive interface lets users adjust the view to suit their needs.

With it, you can work through large datasets and locate specific documents with ease, keeping the information most relevant to your workflow within easy reach.

Key Features

  • Display data from other sites
  • Query Builder to create complex CAML queries
  • Filter Panel to search relevant information
  • Export to Excel

Important
The List Filter Web Part does not support selecting an existing view. Instead, you select the columns that you want to display in the web part.

Web Part Layout

The web part combines three main elements: a command bar, a filter panel, and a results table. The results table is always visible and cannot be hidden, unlike the other two elements.

List Filter Online Web Part

List Filter Online Web Part

📝 Note
List Filter Online cannot be connected to other web parts, but it can be used as a standalone tool to filter data.

API Permissions

The List Filter Online web part uses the native SharePoint REST API to retrieve data from lists and document libraries. As a result, it needs no additional permissions and can be deployed and used immediately.

📝 Note
The List Filter Online web part requires no API permissions and is ready to use immediately after deployment.

Web Part Configuration

After you deploy the package, the List Filter Online web part appears in the web part gallery.

Web Part Gallery

SharePoint Online Web Part Gallery

💡 Tip
To deploy the web part in your environment, see the KB10035. Installing Cloud-based Product article.

After you add the List Filter web part to a page, you'll see the following alert:

Configuration Required Message

Configuration Required Message

You need to provide three required parameters:

  1. Site. The SharePoint Site in the current Site Collection that contains the list you want to display data from.
  2. List or Library. The list or library that contains the data you want to retrieve and display.
  3. Columns. The set of columns you want to include in the list view.

To configure the web part, click Configure Web Part to open the configuration panel.

Data Source

The first section is where you specify the parameters for displaying data. The web part can show information from any SharePoint site.

List Filter Data Source Settings

List Filter Data Source Settings

To choose a site, enter its URL or name in the search bar and select it from the suggestions. Then choose a specific list or document library within that site.

Columns

The last required parameter is the set of columns to display in the list view. Click the Select Columns button to open the column options panel.

List Filter Data Source Settings

List Filter Data Source Settings

Important
The List Filter Web Part does not support selecting an existing view. Instead, you select the columns that you want to display in the web part.

Columns Display Options

For each column in the list view, you can set a caption, order, and other options that control how the column behaves.

IconNameDescription
Resizable iconResizableAllow users to resize column
Collapsible iconCollapsibleAllow the web part to collapse the column if there is not enough space for it
Filterable iconFilterableAllow users to filter the column values by selecting one or more options in the column context menu
Sortable iconSortableAllow sorting the view by column
Link to item iconLink to ItemDisplay column value as a link to item or document

💡 Tip
The List Filter web part lets you customize columns, including the caption, format, display order, and appearance.

Folders

This section controls how data in your folders is displayed.

List Filter Folders Settings

List Filter Folder Settings

You can choose from several options:

Show items inside folder (default). Displays the items inside each folder separately.
Show all items without folders. Shows all items at the same level, with no folders — a "flat" view.
Display all items. Shows all items and their folders at the same level.

Item Limit

This section controls how many items appear in the view. Use the slider to adjust the number.

List Filter Pagination Settings

List Filter Pagination Settings

Pagination

To enable pagination, select Display items in batches of the specified size and choose where the pagination control appears (top, bottom, or both).
To disable pagination, select Limit the total number of items returned to the specified amount and enter the number you want.

Sorting

You can sort the view by up to two columns.

List Filter Sort Settings

List Filter Sort Settings

Group By

Grouping items helps you navigate and understand the data more easily. To group items, select up to two columns in the Group By section of the web part settings:

List Filter Group By Settings

List Filter Group By Settings

Important
The List Filter Online web part currently does not support collapsed grouping. We are working on this feature and plan to include it in a future update.

Totals

Totals let you perform simple calculations on specific columns in the list view.

List Filter Totals Settings

List Filter Totals Settings

To configure totals, click the Select Columns button under the Totals heading in the configuration pane and choose the function to apply (Count, Average, Maximum, Minimum, Sum, Standard Deviation, or Variance).

List Filter Totals Columns Settings

List Filter Totals Columns Settings

Filter

The List Filter web part includes a Query Builder for creating complex queries that retrieve specific data from your SharePoint lists and libraries.

List Filter Query Settings

List Filter Query Settings

The Query Builder lets you group conditions, nest groups, and specify controls to build a filter query.

List Filter Query Builder

List Filter Query Builder

📝 Note
The List Filter Query Builder creates a CAML query to retrieve data from a SharePoint list or library.

Filter Pane

The filter pane lets end users filter the list view using the columns and controls that an administrator has specified.

List Filter Filtering Pane Settings

List Filter Filtering Pane Settings

To choose the columns and filter types, click the Select Columns button and select the columns that will be available for filtering.

List Filter Filtering Pane Columns Settings

List Filter Filtering Pane Columns Settings

Command Toolbar

You can show or hide the command toolbar above the list view.

List Filter Command Toolbar Settings

List Filter Command Toolbar Settings

Appearance

The last section of the configuration panel controls the web part's appearance. You can adjust the following settings:

  • Compact. Display the list in a compact format to reduce the space between rows.
  • Navigation. Show or hide the breadcrumb navigation bar above the results.
  • Selection Mode. Choose from three options: none, single selection, or multiple selection.

List Filter Appearance Settings

List Filter Appearance Settings

Summary

The Vitextra List Filter Online web part is an essential tool for managing data in SharePoint Online. It lets users efficiently filter and retrieve data from lists and document libraries, improving both accuracy and productivity. With its extensive configuration options, the web part adapts to the specific needs of any organization — a valuable addition to your SharePoint toolkit.

Share