File

projects/m2-core/src/lib/model/auxiliary/datatable/DatatableFilters.ts

Index

Methods
Accessors

Methods

Public clearAllFilters
clearAllFilters()
Returns : void
Public getSearchFiltersInfo
getSearchFiltersInfo(uiFilters: U[])
Type parameters :
  • U
  • F

Extended search

Parameters :
Name Type Optional
uiFilters U[] No
Returns : SearchFilterInfo[]
Public hasFilter
hasFilter(predicate: (filter: ElementFilter) => void)
Parameters :
Name Type Optional
predicate function No
Returns : boolean
Public isNoValuesFacetingFilterSet
isNoValuesFacetingFilterSet(columnId: string)
Parameters :
Name Type Optional
columnId string No
Returns : boolean
Public removeAllExtSearchFilters
removeAllExtSearchFilters()
Returns : boolean
Public removeFacetingSearchFilter
removeFacetingSearchFilter(columnId: string)
Parameters :
Name Type Optional
columnId string No
Returns : void
Public removeFacetingSearchFilters
removeFacetingSearchFilters()
Returns : ElementFilter[]
Public removeFilter
removeFilter(columnId: string)
Parameters :
Name Type Optional
columnId string No
Returns : boolean
Public setExternalFacetingSearchFilter
setExternalFacetingSearchFilter(columnId: string, value: any)
Parameters :
Name Type Optional
columnId string No
value any No
Returns : void
Public setFacetingSearchFilter
setFacetingSearchFilter(columnId: string, facetIds: string[], leaveAsIsFacetIds: string[])

Facets

Parameters :
Name Type Optional
columnId string No
facetIds string[] No
leaveAsIsFacetIds string[] No
Returns : void
Public setFastSearchFilter
setFastSearchFilter(searchQuery: string | null)

{boolean} true - if filter changed, otherwise - false

Parameters :
Name Type Optional
searchQuery string | null No
Returns : boolean
Public setFilter
setFilter(filter: ElementFilter)

Abstract filter

Parameters :
Name Type Optional
filter ElementFilter No
Returns : void
Public setItemIdsFilter
setItemIdsFilter(filter?: ItemIdsFilter)
Parameters :
Name Type Optional
filter ItemIdsFilter Yes
Returns : boolean
Public setNodeIdsFilter
setNodeIdsFilter(nodeIds: number[])

Node ids filter

Parameters :
Name Type Optional
nodeIds number[] No
Returns : void
Public setTreeSearchFilter
setTreeSearchFilter(searchQuery: string)

{boolean} true - if filter changed, otherwise - false

Parameters :
Name Type Optional
searchQuery string No
Returns : boolean
Public substituteFilters
substituteFilters(filters: ElementFilter[])
Parameters :
Name Type Optional
filters ElementFilter[] No
Returns : void
Public toQueryParams
toQueryParams(encode: boolean, addTreeFilter: boolean, typesToSkip?: ElementFilterType[])
Parameters :
Name Type Optional
encode boolean No
addTreeFilter boolean No
typesToSkip ElementFilterType[] Yes
Returns : Params

Accessors

allFilters
getallFilters()

Common

Returns : ElementFilter[]
areFiltersSet
getareFiltersSet()
facetedColumnIds
getfacetedColumnIds()
isTreeSearchFilterSet
getisTreeSearchFilterSet()

Tree search

Returns : boolean
treeSearchFilter
gettreeSearchFilter()

results matching ""

    No results matching ""