add hidden option to AdHocFilters

grafana · Dec 20, 2024 · 88e9d95 · 88e9d95
1 parent fc15e94
commit 88e9d95
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 5 deletions.
diff --git a/packages/scenes/src/variables/adhoc/AdHocFiltersVariable.tsx b/packages/scenes/src/variables/adhoc/AdHocFiltersVariable.tsx
@@ -22,6 +22,8 @@ export interface AdHocFilterWithLabels extends AdHocVariableFilter {
   valueLabels?: string[];
   // this is used to externally trigger edit mode in combobox filter UI
   forceEdit?: boolean;
+  // hide the filter from AdHocFiltersVariableRenderer and the URL
+  hidden?: boolean;
 }
 
 export type AdHocControlsLayout = ControlsLayout | 'combobox';
@@ -402,11 +404,13 @@ export function AdHocFiltersVariableRenderer({ model }: SceneComponentProps<AdHo
 
   return (
     <div className={styles.wrapper}>
-      {filters.map((filter, index) => (
-        <React.Fragment key={index}>
-          <AdHocFilterRenderer filter={filter} model={model} />
-        </React.Fragment>
-      ))}
+      {filters
+        .filter((filter) => !filter.hidden)
+        .map((filter, index) => (
+          <React.Fragment key={index}>
+            <AdHocFilterRenderer filter={filter} model={model} />
+          </React.Fragment>
+        ))}
 
       {!readOnly && <AdHocFilterBuilder model={model} key="'builder" addFilterButtonText={addFilterButtonText} />}
     </div>

diff --git a/packages/scenes/src/variables/adhoc/AdHocFiltersVariableUrlSyncHandler.ts b/packages/scenes/src/variables/adhoc/AdHocFiltersVariableUrlSyncHandler.ts
@@ -27,6 +27,7 @@ export class AdHocFiltersVariableUrlSyncHandler implements SceneObjectUrlSyncHan
 
     const value = filters
       .filter(isFilterComplete)
+      .filter((filter) => !filter.hidden)
       .map((filter) => toArray(filter).map(escapeUrlPipeDelimiters).join('|'));
     return { [this.getKey()]: value };
   }