Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FilterComponent

Filter component

Usage:

// Individual module import
import { FilterModule } from 'patternfly-ng/filter';
// Or
import { FilterModule } from 'patternfly-ng';

@NgModule({ imports: [FilterModule,...] }) export class AppModule(){}

Optional:

import {
  Filter,
  FilterConfig,
  FilterField,
  FilterEvent,
  FilterType
} from 'patternfly-ng/filter';

Hierarchy

  • FilterComponent

Implements

  • DoCheck
  • OnInit

Index

Constructors

constructor

Properties

config

config: FilterConfig

The filter config containing component properties

onChange

onChange: EventEmitter<Object> = new EventEmitter()

The event emitted when a filter has been changed

onDelete

onDelete: EventEmitter<Object> = new EventEmitter()

The event emitted when a query (i.e., saved filter) has been deleted

onFilterSelect

onFilterSelect: EventEmitter<Object> = new EventEmitter()

The event emitted when a field menu option is selected

onSave

onSave: EventEmitter<Object> = new EventEmitter()

The event emitted when a filter has been changed

onTypeAhead

onTypeAhead: EventEmitter<Object> = new EventEmitter()

The event emitted when the user types ahead in the query input field

Methods

addFilter

clearFilter

  • clearFilter($event: Filter[]): void

deleteQuery

fieldSelected

ngDoCheck

  • ngDoCheck(): void

ngOnInit

  • ngOnInit(): void

resetCurrentField

  • resetCurrentField(): void

saveFilter

Protected setupConfig

  • setupConfig(): void

typeAhead

Generated using TypeDoc