Home Reference Source Repository
import {MarkActiveColumns} from 'tablefilter/src/modules/markActiveColumns.js'
public class | source

MarkActiveColumns

Extends:

Feature → MarkActiveColumns

Visual indicator for filtered columns

Constructor Summary

Public Constructor
public

Create an instance of MarkActiveColumns

Member Summary

Public Members
public

Css class for filtered (active) columns

public
public

Callback fired after a column is marked as filtered

public

Callback fired before a column is marked as filtered

Method Summary

Public Methods
public

Clear filtered columns visual indicator (background color)

public

Remove feature

public

init()

Initialise MarkActiveColumns instance

public

Mark currently filtered column

Inherited Summary

From class Feature
public

TableFilter configuration

public

TableFilter emitter instance

public

TableFilter feature setting

public

Feature name

public

Field indicating whether Feature is initialized

public

TableFilter instance

public

Destroy the feature

public

Disable the feature

public

enable()

Enable the feature

public

init()

Initialize the feature

public

Indicate whether the feature is enabled or not

public

reset()

Reset the feature after being disabled

Public Constructors

public constructor(tf: TableFilter) source

Create an instance of MarkActiveColumns

Override:

Feature#constructor

Params:

NameTypeAttributeDescription
tf TableFilter

TableFilter instance

Public Members

public headerCssClass: String source

Css class for filtered (active) columns

public initialized: boolean source

Override:

Feature#initialized

public onAfterActiveColumn: Function source

Callback fired after a column is marked as filtered

public onBeforeActiveColumn: Function source

Callback fired before a column is marked as filtered

Public Methods

public clearActiveColumns() source

Clear filtered columns visual indicator (background color)

public destroy() source

Remove feature

Override:

Feature#destroy

public init() source

Initialise MarkActiveColumns instance

Override:

Feature#init

public markActiveColumn(colIndex: Number) source

Mark currently filtered column

Params:

NameTypeAttributeDescription
colIndex Number

Column index