Home Reference Source
import {ClearButton} from 'tablefilter/src/modules/clearButton.js'
public class | source

ClearButton

Extends:

Feature → ClearButton

Clear button UI component

Constructor Summary

Public Constructor
public

Creates an instance of ClearButton

Member Summary

Public Members
public

Css class for reset button

public

Custom Html string for the clear button

public
public

Container element ID

public

Text for the clear button

public

Default position in toolbar ('left'|'center'|'right')

public

Tooltip text for the clear button

Method Summary

Public Methods
public

Destroy ClearButton instance

public

init()

Initialize clear button component

Inherited Summary

From class Feature
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

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

Creates an instance of ClearButton

Override:

Feature#constructor

Params:

NameTypeAttributeDescription
tf TableFilter

TableFilter instance

Public Members

public cssClass: String source

Css class for reset button

public html: String source

Custom Html string for the clear button

public initialized: boolean source

Field indicating whether Feature is initialized

Override:

Feature#initialized

public targetId: String source

Container element ID

public text: String source

Text for the clear button

public toolbarPosition: String source

Default position in toolbar ('left'|'center'|'right')

public tooltip: String source

Tooltip text for the clear button

Public Methods

public destroy() source

Destroy ClearButton instance

Override:

Feature#destroy

public init() source

Initialize clear button component

Override:

Feature#init