CLEAN_WIDGET (Only for DEF-Class Functions)- FineBI Document

Last update：July 01, 2024

Overview

Syntax	CLEAN_WIDGET(Field 1,Field 2,Field 3....) /CLEAN_WIDGET("ALL")	Function used to ignore the filtering effects generated in the component by the specified fields during the calculation of the current analysis function.
Parameter	Field 1,Field 2,Field 3....	Fields that generate the filtering effects to be ignored. Dimension/indicator fields of any types (including calculation fields) are supported. If "ALL" is specified in CLEAN_WIDGET, the system clears the filtering effects generated in the component by all fields during the calculation of the current analysis function. Default field values are not supported.

Syntax

CLEAN_WIDGET(Field 1,Field 2,Field 3....)

/CLEAN_WIDGET("ALL")

Function used to ignore the filtering effects generated in the component by the specified fields during the calculation of the current analysis function.

Parameter

Field 1,Field 2,Field 3....

Fields that generate the filtering effects to be ignored.

Dimension/indicator fields of any types (including calculation fields) are supported.
If "ALL" is specified in CLEAN_WIDGET, the system clears the filtering effects generated in the component by all fields during the calculation of the current analysis function.
Default field values are not supported.

Notes

This function can only be used in DEF/DEF_ADD/DEF_SUN as a standalone filtering condition.

Difference with the CLEAN Function

Calculation Range

The main difference lies in the range of filtering effects to be ignored. CLEAN_WIDGET clears only the filtering effects generated in the component and does not clear the filtering effects in the dashboard.

Range	Field Filtering	CLEAN_WIDGET (Field 1,Field 2,Field 3....)	CLEAN_WIDGET ("ALL")
Component	Filter Drilling	Field filtering effects are ignored.	The filtering effects generated by all fields in the analysis function are ignored.
Dashboard	Linkage Jump Filter Component	Filtering effects are generated normally.	Filtering effects are generated normally.

Calculation Logic in DEF

The calculation logic in DEF is the same as that in CLEAN.

Example

Formula	Result	Remarks
DEF(SUM_AGG(Indicator),[Province,City],[CLEAN_WIDGET(City)])	The filtering effects generated by the City field are ignored during the DEF calculation.	/
DEF_ADD(SUM_AGG(),[],[CLEAN_WIDGET("ALL")])	All filtering effects in the component are ignored during the DEF_ADD calculation.	/

Helpful
Not helpful
Only read

中文（简体）中文（繁體）日本語

English