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	constructor(tf: TableFilter) Create an instance of MarkActiveColumns

Member Summary

Public Members
public	cellCssClass: String Css class for filtered (active) column cells
public	headerCssClass: String Css class for filtered (active) columns
public	highlightColumn: Boolean Enable/disable column highlighting
public	initialized: boolean
public	onAfterActiveColumn: Function Callback fired after a column is marked as filtered
public	onBeforeActiveColumn: Function Callback fired before a column is marked as filtered

Method Summary

Public Methods
public	clearActiveColumns() Clear filtered columns visual indicator (background color)
public	destroy() Remove feature
public	init() Initialise MarkActiveColumns instance
public	markActiveColumn(colIndex: Number) Mark currently filtered column

Inherited Summary

From class Feature
public	config: Object TableFilter configuration
public	emitter: Emitter TableFilter emitter instance
public	enabled: Boolean TableFilter feature setting
public	feature: String Feature name is the camelised class name as per TableFilter's convention
public	initialized: Boolean Field indicating whether Feature is initialized
public	tf: TableFilter TableFilter instance
public	destroy() Destroy the feature
public	disable() Disable the feature
public	enable() Enable the feature
public	init() Initialize the feature
public	isEnabled(): Boolean 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:

Name	Type	Attribute	Description
tf	TableFilter		TableFilter instance

Public Members

public cellCssClass: String source

Css class for filtered (active) column cells

public headerCssClass: String source

Css class for filtered (active) columns

public highlightColumn: Boolean source

Enable/disable column highlighting

public initialized: boolean source

Field indicating whether Feature is initialized

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:

Name	Type	Attribute	Description
colIndex	Number		Column index