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

RowsCounter

Extends:

Feature → RowsCounter

Rows counter UI component

Constructor Summary

Public Constructor
public

Creates an instance of RowsCounter

Member Summary

Public Members
public

Css class for container element

public

Separator symbol appearing between the first and last visible rows of current page when paging is enabled.

public
public

Callback fired after the counter is refreshed

public

Callback fired before the counter is refreshed

public

Separator symbol appearing between the first and last visible rows of current page and the total number of filterable rows when paging is enabled.

public

ID of custom container element

public

Text preceding the total number of rows

public

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

Method Summary

Public Methods
public

Remove feature

public

init()

Initializes RowsCounter instance

public

Refreshes the rows counter

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 RowsCounter

Override:

Feature#constructor

Params:

NameTypeAttributeDescription
tf TableFilter

TableFilter instance

Public Members

public cssClass: String source

Css class for container element

public fromToTextSeparator: String source

Separator symbol appearing between the first and last visible rows of current page when paging is enabled. ie: Rows: 31-40 / 70

public initialized: boolean source

Field indicating whether Feature is initialized

Override:

Feature#initialized

public onAfterRefreshCounter: Function source

Callback fired after the counter is refreshed

public onBeforeRefreshCounter: Function source

Callback fired before the counter is refreshed

public overText: String source

Separator symbol appearing between the first and last visible rows of current page and the total number of filterable rows when paging is enabled. ie: Rows: 31-40 / 70

public targetId: String source

ID of custom container element

public text: String source

Text preceding the total number of rows

public toolbarPosition: String source

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

Public Methods

public destroy() source

Remove feature

Override:

Feature#destroy

public init() source

Initializes RowsCounter instance

Override:

Feature#init

public refresh(p: Number) source

Refreshes the rows counter

Params:

NameTypeAttributeDescription
p Number

Optional parameter the total number of rows to display