Member Junction
    Preparing search index...

    Class FilterBuilderComponent

    FilterBuilderComponent - Main filter builder component

    Provides a complete UI for building complex filter expressions with AND/OR logic and nested groups. Outputs Kendo-compatible CompositeFilterDescriptor JSON format.

    <mj-filter-builder
      [fields]="filterFields"
      [filter]="currentFilter"
      (filterChange)="onFilterChange($event)"
      (apply)="onApply($event)">
    </mj-filter-builder>

    Implements

    • OnInit
    • OnChanges
    Index

    Constructors

    constructor

    Properties

    apply Apply clear Clear config Disabled fields Filter filterChange FilterChange HasActiveFilters InternalFilter IsSummaryExpanded MergedConfig ShowSummary Sources

    Accessors

    disabled effectiveFields EffectiveFields filter hasActiveFilters internalFilter isSummaryExpanded mergedConfig showSummary sources

    Methods

    GetFilterCount GetFilterSummaryHtml ngOnChanges ngOnInit onApply OnApply onClear OnClear onFilterChange toggleSummary ToggleSummary

    Constructors

    Properties

    apply: EventEmitter<CompositeFilterDescriptor> = ...

    Use Apply.

    The same emitter under the old binding name, so a template still binding (apply) keeps working. Must stay AFTER Apply: class fields initialise in order, and the other way round this captures undefined.

    Apply: EventEmitter<CompositeFilterDescriptor> = ...

    Emitted when the Apply button is clicked (if showApplyButton is true)

    clear: EventEmitter<void> = ...

    Use Clear.

    The same emitter under the old binding name, so a template still binding (clear) keeps working. Must stay AFTER Clear: class fields initialise in order, and the other way round this captures undefined.

    Clear: EventEmitter<void> = ...

    Emitted when the Clear button is clicked

    config: Partial<FilterBuilderConfig> = {}

    Configuration options

    Disabled: boolean = false

    Whether the component is disabled

    fields: FilterFieldInfo[] = []

    Available fields to filter on

    Filter: CompositeFilterDescriptor | null = null

    Current filter state (Kendo-compatible CompositeFilterDescriptor)

    filterChange: EventEmitter<CompositeFilterDescriptor> = ...

    Use FilterChange.

    The same emitter under the old binding name, so a template still binding (filterChange) keeps working. Must stay AFTER FilterChange: class fields initialise in order, and the other way round this captures undefined.

    FilterChange: EventEmitter<CompositeFilterDescriptor> = ...

    Emitted when the filter changes

    HasActiveFilters: boolean = false

    Whether there are any active filters

    InternalFilter: CompositeFilterDescriptor = ...

    Internal filter state

    IsSummaryExpanded: boolean = false

    Whether the filter summary is expanded (visible)

    MergedConfig: FilterBuilderConfig = ...

    Merged configuration

    ShowSummary: boolean = false

    Whether to show the natural language filter summary at the bottom

    Sources: FilterSource[] | null = null

    When set (even one source), every written field is source.key.fieldName. Several sources: two-pane field picker. One source: same JSON prefix, simpler picker. Omit for legacy views that still persist bare field names.

    Accessors

    Methods

    • A callback method that is invoked immediately after the default change detector has checked data-bound properties if at least one has changed, and before the view and content children are checked.

      Parameters

      • changes: { [propName: string]: SimpleChange<any> }

        The changed properties.

      Returns void

    • A callback method that is invoked immediately after the default change detector has checked the directive's data-bound properties for the first time, and before any of the view or content children have been checked. It is invoked only once when the directive is instantiated.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods