Class Column<T>

Type parameters

T = unknown

Hierarchy

Column

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Column<T>(name: string, direction?: ColumnSortDirection): Column<T>

- Defined in lib/column/column.ts:31
Type parameters
- T = unknown
Parameters
- name: string
- direction: ColumnSortDirection = ...
Returns Column<T>

Properties

direction

direction: ColumnSortDirection

Sort direction

Private filterRules

filterRules: Set<FilterRule<T>> = ...

Readonly name

name: string

Name of column

Private sortRule

sortRule: null | SortRule<T> = null

Accessors

hasFilters

get hasFilters(): boolean

- Defined in lib/column/column.ts:29
Indicates column has at least one of filterRule

Returns boolean

hasSort

get hasSort(): boolean

- Defined in lib/column/column.ts:22
Indicates column has sort

Returns boolean

Methods

addFilter

addFilter(filterRule: FilterRule<T>): void

- Defined in lib/column/column.ts:114
Add filtration

Parameters
- filterRule: FilterRule<T>
Returns void

filter

filter(item: T): boolean

- Defined in lib/column/column.ts:83
Call all filters

All filters sums by {@link Array#every} when all filters return true it return true, otherwise false

When no one filters exists return TRUE

Parameters
- item: T
  
  Active item for filtration
Returns boolean

When all filters returns true, then return TRUE, otherwise FALSE

removeFilter

removeFilter(filterRule: FilterRule<T>): void

- Defined in lib/column/column.ts:123
Remove filtration

Parameters
- filterRule: FilterRule<T>
Returns void

setDirection

setDirection(direction: ColumnSortDirection): void

- Defined in lib/column/column.ts:141
Set sort direction

Parameters
- direction: ColumnSortDirection
  
  Sort direction
Returns void

setSort

setSort(sortRule: null | SortRule<T>): void

- Defined in lib/column/column.ts:96
Set sort rule

Parameters
- sortRule: null | SortRule<T>
  
  Sort rule or null
Returns void

sort

sort(a: T, b: T): number

- Defined in lib/column/column.ts:64
Call sort rule

Parameters
- a: T
  
  Current item
- b: T
  
  Next item
Returns number

takeAllFilters

takeAllFilters(): readonly FilterRule<T>[]

- Defined in lib/column/column.ts:132
Take all filters

Returns readonly FilterRule<T>[]

Readonly list of filters

takeSort

takeSort(): null | SortRule<T>

- Defined in lib/column/column.ts:105
Take sort rule or null

Returns null | SortRule<T>

Sort rule or null

Static build

build<R>(name: string, filters?: FilterRule<unknown>[], sort?: null | SortRule<unknown>, direction?: ColumnSortDirection): Column<R>

- Defined in lib/column/column.ts:46
Column builder

Type parameters
- R
Parameters
- name: string
  
  Column name
- filters: FilterRule<unknown>[] = []
  
  List of filter rules
- sort: null | SortRule<unknown> = null
  
  Sort rule
- direction: ColumnSortDirection = ...
  
  Sort direction
Returns Column<R>

Generated using TypeDoc