Home Reference Source Repository
public class | source

FiltersVisibility

Extends:

Feature → FiltersVisibility

Filters Visibility extension

Constructor Summary

Public Constructor
public

constructor(tf: TableFilter, Configuration: Object)

Creates an instance of FiltersVisibility

Member Summary

Public Members
public

Css class for expand/collapse filters button

public

Button's custom HTML

public

Custom text for button

public

Css class for main container

public

Module description

public

Enable expand/collapse icon, defaults to true

public

Filters row index

public

Collapse icon filename

public

Expand icon filename

public
public

Module name

public

Callback fired after filters row is hidden

public

Callback fired after filters row is shown

public

Callback fired before filters row is hidden

public

Callback fired before filters row is shown

public

Extension's stylesheet filename

public

ID of main container element

public

Make filters visible at initialization, defaults to true

Method Summary

Public Methods
public

Build UI elements

public

Destroy the UI

public

init()

Initialise extension

public

show(visible: boolean)

Show or hide filters

public

toggle()

Toggle filters visibility

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, Configuration: Object) source

Creates an instance of FiltersVisibility

Override:

Feature#constructor

Params:

NameTypeAttributeDescription
tf TableFilter

TableFilter instance

Configuration Object

object

Public Members

public btnCssClass: String source

Css class for expand/collapse filters button

public btnHtml: String source

Button's custom HTML

public btnText: String source

Custom text for button

public contCssClass: String source

Css class for main container

public desc: String source

Module description

public enableIcon: Boolean source

Enable expand/collapse icon, defaults to true

public filtersRowIndex: Number source

Filters row index

public icnCollapse: String source

Collapse icon filename

public icnExpand: String source

Expand icon filename

public initialized: boolean source

Override:

Feature#initialized

public name: String source

Module name

public onAfterHide: Function source

Callback fired after filters row is hidden

public onAfterShow: Function source

Callback fired after filters row is shown

public onBeforeHide: Function source

Callback fired before filters row is hidden

public onBeforeShow: Function source

Callback fired before filters row is shown

public stylesheet: String source

Extension's stylesheet filename

public targetId: String source

ID of main container element

public visibleAtStart: Boolean source

Make filters visible at initialization, defaults to true

Public Methods

public buildUI() source

Build UI elements

public destroy() source

Destroy the UI

Override:

Feature#destroy

public init() source

Initialise extension

Override:

Feature#init

public show(visible: boolean) source

Show or hide filters

Params:

NameTypeAttributeDescription
visible boolean
  • optional
  • default: true

Visibility flag

public toggle() source

Toggle filters visibility