Home Reference Source
import {Feature} from 'tablefilter/src/feature.js'
public class | source

Feature

Indirect Subclass:

CheckList, Dropdown

Base class defining the interface of a TableFilter feature

Constructor Summary

Public Constructor
public

constructor(tf: Object, feature: Class)

Creates an instance of Feature

Member Summary

Public Members
public

TableFilter configuration

public

TableFilter emitter instance

public

TableFilter feature setting

public

Feature name is the camelised class name as per TableFilter's convention

public

Field indicating whether Feature is initialized

public

TableFilter instance

Method Summary

Public Methods
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: Object, feature: Class) source

Creates an instance of Feature

Params:

NameTypeAttributeDescription
tf Object

TableFilter instance

feature Class

Feature class for TableFilter registration

Public Members

public config: Object source

TableFilter configuration

public emitter: Emitter source

TableFilter emitter instance

public enabled: Boolean source

TableFilter feature setting

public feature: String source

Feature name is the camelised class name as per TableFilter's convention

public initialized: Boolean source

Field indicating whether Feature is initialized

public tf: TableFilter source

TableFilter instance

Public Methods

public destroy() source

Destroy the feature

public disable() source

Disable the feature

public enable() source

Enable the feature

public init() source

Initialize the feature

public isEnabled(): Boolean source

Indicate whether the feature is enabled or not

Return:

Boolean

public reset() source

Reset the feature after being disabled