Time Filter Component

Version

Application Scenario

• The time filter component can filter the date field data in other components, such as filtering data by year-month, year-quarter, and a specific date interval.

• The basic data involved in components typically spans a long period, and filtering data over a long time span may result in downtime. In addition, data on some dates is meaningless for a query. In this case, you can use the Set Optional Interval function when making time filter components to limit users' selection of a time range.

• You can set the time-filtering condition to a dynamic time relative to the current time, which changes with the date.

Function Description

The time filter component can only filter date-type fields.

There are a total of nine time filter components: Year, Year-Month, Year-Quarter, Date, Date Panel, Date Interval, Year-Month Interval, Button Group, and Date Filter filter components, as shown in the following figure.

Example data: Regional Data Analysis.xlsx

This section takes the year filter component as an example and uses the Regional Data Analysis dataset to illustrate the use of a time filter component.

In this example, you want to select only the data of year 2014 and 2015.

1. Create a component, drag Contract Signing Time into the Dimension bar and Received Payment into the Indicator bar, and set Contract Signing Time to be grouped by Year-Month, as shown in the following figure.

2. Create a dashboard, drag the prepared component to the dashboard, and add a Year filter component, as shown in the following figure.

3. Go to the filter component editing page, drag Contract Signing Time into the Field bar, check Set Optional Interval, and set the interval to 2014-2015, as shown in the following figure.

4. The component displays data of 2014 by default, and only 2014 and 2015 can be chosen as the filtering condition. Other year options are grayed out and unavailable for selection, as shown in the following figure.

By configuring the button group, you can quickly filter the desired time through the buttons.

Setting the Time Button Group

1. Drag Button Group into the dashboard, as shown in the following figure.

2. Drag the date fields that need to be bound.

In this way, you can quickly filter data by a set of dynamic time periods.

Customizing the Button Group Label

To modify the button labels to Q1 2014, Q2 2014, Current Day, This Month, and Last 30 Days:

1. Return to the filter component editing page to manually configure labels. Select Custom Label and click the icon, as shown in the following figure.

2. Go to the setting page, select Current Day, This Month, and Last 30 Days, and click Add Label, as shown in the following figure.

3. Create the labels of Q1 2014 and Q2 2014 and set label names and time periods, as shown in the following figure.

4. Select the created labels and click OK. (You can drag the labels on the right to reorder them.) The following figure shows the settings.

The following figure shows the final effect.

Drag a time filter component into a dashboard and drag Contract Signing Time from the Regional Data Analysis table into the Field bar.

Dynamic Time

You can set the time-filtering condition to a dynamic time compared to the current time, which can change with the date.

For example, if the current date is 2023-12-22, and you want the data of 2023-11-22, you can set the dynamic time as follows and click OK.

The filtering is performed accordingly as the date changes. If the current date turns to 2023-12-28, the data of 2023-11-28 will be displayed.

Current Time

You can set the current time as the filtering condition. For example, when using the date filter component, you can select Today as the filtering condition, as shown in the following figure.

The default current time of the date filter component, date panel filter component, and date interval filter component is Today.

The default current time of the year filter component is Current Year.

The default current time of the year-month filter component and year-month interval filter component is Current Month.

The default current time of the year-quarter filter component is Current Quarter.

Note:

To set a dynamic time relative to the current time, you need to configure the setting in Dynamic Time. For details, see the "Dynamic Time Filtering" section.

Available Options of Different Filter Components for Current Time

Weekday Explanation

The Date, Date Interval, and Date Panel filter components can be used to get the data of certain weekdays before or after the current time.

Weekday modification

By default, all dates except for official holidays are regarded as weekdays in FineBI.

Enterprises can modify the holiday file in FineBI installation path\webapps\webroot\WEB-INF\assets\extdata to match their holidays.

1. Open the holiday file in Notepad, and add or delete holidays as shown in the following figure.

2. Restart the project to apply the changes.

Note:

1. Only the xxxx-xx-xx date format is supported for customizing holidays at this time, as shown in the figure above. The format xxxx/xx/xx is not supported.

2. Do not edit the holiday file directly in Excel. Use a text editor instead. If you modify the holiday file directly in Excel, the dates will be automatically saved in the xxxx/xx/xx format, which may cause filtering errors

holiday File Update

If the holiday file does not contain dates for the latest year:

1. Download the latest holiday file holiday.

2. Upload and replace the new holiday file in the webroot/WEB-INF/assets/extdata path of the project. For cluster projects, upload and replace the holiday file in the assets/extdata path on the cluster file server.

3. Restart the project.

On the editing page of the date filter component, the date panel filter component, and the date interval filter component, you can enable Show Time, which is disabled by default. If it is enabled, you can add the hour, minute, and second to the filtering condition.

1. On the filter component editing page, check Show Time to enable it, as shown in the following figure.

2. The filter component with Show Time enabled is shown in the figure below, and you can filter the data for a specific moment.

3. After the time is displayed, you can precisely set the hour, minute, and second if dynamic time configuration is required.

• Current Time: You can filter data based on the real-time hour, minute, and second when the query is triggered.

• Fixed Time: You can customize a fixed hour, minute, and second (for example, 08:00:00) to implement filtering with a dynamic date plus user-defined fixed hour, minute, and second.

For details about customizing the background color, theme color, title text, and other settings of the filter component, see the "Filter Component Style Setting" section in Dashboard Style.