VisActor VBI
  • English

      • Filter Mutations

      This example demonstrates the mutation entry points for useWhereFilter and useHavingFilter.

      Dependencies

      • Packages: @visactor/vbi-react, @visactor/vbi, react
      • Props: builder should contain at least region and sales fields for demonstrating Where/Having mutations

      Code Snippet

      import type { VBIChartBuilder } from '@visactor/vbi'
import { useHavingFilter, useWhereFilter } from '@visactor/vbi-react'

export function FilterDemo({ builder }: { builder: VBIChartBuilder }) {
  const { whereFilter, mutateWhereFilter, clearWhereFilter } = useWhereFilter(builder)
  const { havingFilter, mutateHavingFilter, clearHavingFilter } = useHavingFilter(builder)

  return (
    <div style={{ display: 'grid', gap: 8 }}>
      <button
        onClick={() =>
          mutateWhereFilter((where) => {
            where.add('region', (node) => node.setOperator('eq').setValue('East'))
          })
        }
      >
        Add Where Condition
      </button>
      <button
        onClick={() =>
          mutateHavingFilter((having) => {
            having.add('sales', (node) => node.setAggregate({ func: 'sum' }).setOperator('gt').setValue(1000))
          })
        }
      >
        Add Having Condition
      </button>
      <button onClick={clearWhereFilter}>Clear Where</button>
      <button onClick={clearHavingFilter}>Clear Having</button>
      <pre>{JSON.stringify({ whereFilter, havingFilter }, null, 2)}</pre>
    </div>
  )
}

      Expected Behavior

      • After clicking buttons, Where/Having conditions are appended to the builder's filter tree.
      • The clear buttons immediately remove the corresponding filter conditions.
      • The JSON at the bottom can be used to confirm the current filter DSL structure.