@types/datatables.net

property data

data: any;

property draw

draw?: number | undefined;

property error

error?: string | undefined;

property recordsFiltered

recordsFiltered?: number | undefined;

property recordsTotal

recordsTotal?: number | undefined;

property columns

columns: AjaxDataRequestColumn[];

property data

data: any;

property draw

draw: number;

property length

length: number;

property order

order: AjaxDataRequestOrder[];

property search

search: AjaxDataRequestSearch;

property start

start: number;

property data

data: string | number;

property name

name: string;

property orderable

orderable: boolean;

property search

search: AjaxDataRequestSearch;

property searchable

searchable: boolean;

property column

column: number;

property dir

dir: string;

property regex

regex: boolean;

property value

value: string;

method json

json: () => object;

• Get the latest JSON data obtained from the last Ajax request DataTables made

method params

params: () => object;

• Get the data submitted by DataTables to the server in the last Ajax request

method reload

reload: (callback?: (json: any) => void, resetPaging?: boolean) => Api;

• Reload the table data from the Ajax data source.

  Parameter callback

  Function which is executed when the data as been reloaded and the table fully redrawn.

  Parameter resetPaging

  Reset (default action or true) or hold the current paging position (false).

method url

url: { (): string; (url: string): AjaxMethods };

• Reload the table data from the Ajax data source

• Reload the table data from the Ajax data source

  Parameter url

  URL to set to be the Ajax data source for the table.

method load

load: (callback?: (json: any) => void, resetPaging?: boolean) => Api;

• Reload the table data from the Ajax data source.

  Parameter callback

  Function which is executed when the data as been reloaded and the table fully redrawn.

  Parameter resetPaging

  Reset (default action or true) or hold the current paging position (false).

property data

data?: object | FunctionAjaxData | undefined;

• Add or modify data submitted to the server upon an Ajax request. Since: 1.10

property dataSrc

dataSrc?: string | ((data: any) => any[]) | undefined;

• Data property or manipulation method for table data. Since: 1.10

property column

column: ColumnMethodsModel;

• Column Methods / object

property columns

columns: ColumnsMethodsModel;

• Columns Methods / object

property order

order: OrderMethods;

• Order Methods / object

property row

row: RowMethodsModel;

• Row Methode / object

property rows

rows: RowsMethodsModel;

• Rows Methods / object

method cell

cell: {
    (cellSelector: any, modifier?: ObjectSelectorModifier): CellMethods;
    (
        rowSelector: any,
        cellSelector: any,
        modifier?: ObjectSelectorModifier
    ): CellMethods;
};

• Select the cell found by a cell selector

  Parameter cellSelector

  Cell selector.

  Parameter Option

  used to specify how the cells should be ordered, and if paging or filtering

• Select the cell found by a cell selector

  Parameter rowSelector

  Row selector.

  Parameter cellSelector

  Cell selector.

  Parameter Option

  used to specify how the cells should be ordered, and if paging or filtering

method cells

cells: {
    (modifier?: ObjectSelectorModifier): CellsMethods;
    (cellSelector: any, modifier?: ObjectSelectorModifier): CellsMethods;
    (
        rowSelector: any,
        cellSelector: any,
        modifier?: ObjectSelectorModifier
    ): CellsMethods;
};

• Select all cells

  Parameter Option

  used to specify how the cells should be ordered, and if paging or filtering

• Select cells found by a cell selector

  Parameter cellSelector

  Cell selector.

  Parameter Option

  used to specify how the cells should be ordered, and if paging or filtering

• Select cells found by both row and column selectors

  Parameter rowSelector

  Row selector.

  Parameter cellSelector

  Cell selector.

  Parameter Option

  used to specify how the cells should be ordered, and if paging or filtering

method data

data: () => Api;

• Get the data for the whole table.

method table

table: (tableSelector: any) => TableMethods;

• Select a table based on a selector from the API's context

  Parameter tableSelector

  Table selector.

method tables

tables: (tableSelector?: any) => TablesMethods;

• Select tables based on the given selector

  Parameter tableSelector

  Table selector.

call signature

(selector: string | Node | Node[] | JQuery): Api;

• Returns DataTables API instance

  Parameter table

  Selector string for table

index signature

[key: number]: any;

• API should be array-like

index signature

[index: string]: Node;

property barWidth

barWidth: number;

property bBounding

bBounding: boolean;

property bScrollbarLeft

bScrollbarLeft: boolean;

property bScrollOversize

bScrollOversize: boolean;

property column

column: number;

property columnVisible

columnVisible: number;

property row

row: number;

property col

col: number;

property row

row: number;

property settings

settings: Settings;

method data

data: { (): any; (data: any): Api };

• Get data for the selected cell

• Get data for the selected cell

  Parameter data

  Value to assign to the data for the cell

method index

index: () => CellIndexReturn;

• Get index information about the selected cell

method node

node: () => Node;

• Get the DOM element for the selected cell

method data

data: () => Api;

• Get data for the selected cells

method every

every: (
    fn: (
        this: CellMethods,
        cellRowIdx: number,
        cellColIdx: number,
        tableLoop: number,
        cellLoop: number
    ) => void
) => Api;

• Iterate over each selected cell, with the function context set to be the cell in question. Since: DataTables 1.10.6

  Parameter fn

  Function to execute for every cell selected.

method indexes

indexes: () => Api;

• Get index information about the selected cells

method nodes

nodes: () => Api;

• Get the DOM elements for the selected cells

property targets

targets: string | number | Array<number | string>;

property aDataSort

aDataSort: any;

property asSorting

asSorting: string[];

property bSearchable

bSearchable: boolean;

property bSortable

bSortable: boolean;

property bVisible

bVisible: boolean;

property fnCreatedCell

fnCreatedCell: FunctionColumnCreatedCell;

property idx

idx: number;

property mData

mData: any;

property mRender

mRender: any;

property nIf

nIf: Node;

property nTh

nTh: Node;

property sClass

sClass: string;

property sContentPadding

sContentPadding: string;

property sDefaultContent

sDefaultContent: string;

property sName

sName: string;

property sSortDataType

sSortDataType: string;

property sSortingClass

sSortingClass: string;

property sSortingClassJUI

sSortingClassJUI: string;

property sTitle

sTitle: string;

property sType

sType: string;

property sWidth

sWidth: string;

property sWidthOrig

sWidthOrig: string;

method fnGetData

fnGetData: (data: any, specific: string) => any;

method fnSetData

fnSetData: (data: any, value: any) => void;

method data

data: () => Api;

• Get the data for the cells in the selected column.

method dataSrc

dataSrc: () => number | string | (() => string);

• Get the data source property for the selected column

method index

index: (t?: string) => number;

• Get index information about the selected cell

  Parameter t

  Specify if you want to get the column data index (default) or the visible index (visible).

method nodes

nodes: () => Api;

• Obtain the th / td nodes for the selected column

method index

index: (t: string, index: number) => number;

• Convert from the input column index type to that required.

  Parameter t

  The type on conversion that should take place: 'fromVisible', 'toData', 'fromData', 'toVisible'

  Parameter index

  The index to be converted

call signature

(columnSelector: any, modifier?: ObjectSelectorModifier): ColumnMethods;

• Select the column found by a column selector

  Parameter cellSelector

  Cell selector.

  Parameter Option

  used to specify how the cells should be ordered, and if paging or filtering in the table should be taken into account.

property cellType

cellType?: string | undefined;

• Cell type to be created for a column. th/td Since: 1.10

property className

className?: string | undefined;

• Class to assign to each cell in the column. Since: 1.10

property contentPadding

contentPadding?: string | undefined;

• Add padding to the text content used when calculating the optimal with for a table. Since: 1.10

property createdCell

createdCell?: FunctionColumnCreatedCell | undefined;

• Cell created callback to allow DOM manipulation. Since: 1.10

property data

data?:
    | number
    | string
    | ObjectColumnData
    | FunctionColumnData
    | null
    | undefined;

• Class to assign to each cell in the column. Since: 1.10

property defaultContent

defaultContent?: string | undefined;

• Set default, static, content for a column. Since: 1.10

property name

name?: string | undefined;

• Set a descriptive name for a column. Since: 1.10

property orderable

orderable?: boolean | undefined;

• Enable or disable ordering on this column. Since: 1.10

property orderData

orderData?: number | number[] | undefined;

• Define multiple column ordering as the default order for a column. Since: 1.10

property orderDataType

orderDataType?: string | undefined;

• Live DOM sorting type assignment. Since: 1.10

property orderFixed

orderFixed?: any[] | ObjectOrderFixed | undefined;

• Ordering to always be applied to the table. Since 1.10

  Array type is prefix ordering only and is a two-element array: 0: Column index to order upon. 1: Direction so order to apply ("asc" for ascending order or "desc" for descending order).

property orderSequence

orderSequence?: string[] | undefined;

• Order direction application sequence. Since: 1.10

property render

render?:
    | number
    | string
    | ObjectColumnData
    | FunctionColumnRender
    | ObjectColumnRender
    | undefined;

• Render (process) the data for use in the table. Since: 1.10

property searchable

searchable?: boolean | undefined;

• Enable or disable filtering on the data in this column. Since: 1.10

property title

title?: string | undefined;

• Set the column title. Since: 1.10

property type

type?: string | undefined;

• Set the column type - used for filtering and sorting string processing. Since: 1.10

property visible

visible?: boolean | undefined;

• Enable or disable the display of this column. Since: 1.10

property width

width?: string | undefined;

• Column width assignment. Since: 1.10

method data

data: () => Api;

• Obtain the data for the columns from the selector

method dataSrc

dataSrc: () => Api;

• Get the data source property for the selected columns.

method every

every: (
    fn: (
        this: ColumnMethods,
        colIdx: number,
        tableLoop: number,
        colLoop: number
    ) => void
) => Api;

• Iterate over each selected column, with the function context set to be the column in question. Since: DataTables 1.10.6

  Parameter fn

  Function to execute for every column selected.

method indexes

indexes: (t?: string) => Api;

• Get the column indexes of the selected columns.

  Parameter t

  Specify if you want to get the column data index (default) or the visible index (visible).

method nodes

nodes: () => Api[][];

• Obtain the th / td nodes for the selected columns

method adjust

adjust: () => Api;

• Recalculate the column widths for layout.

call signature

(modifier?: ObjectSelectorModifier): ColumnsMethods;

• Select all columns

  Parameter Option

  used to specify how the cells should be ordered, and if paging or filtering in the table should be taken into account.

call signature

(columnSelector: any, modifier?: ObjectSelectorModifier): ColumnsMethods;

• Select columns found by a cell selector

  Parameter cellSelector

  Cell selector.

  Parameter Option

  used to specify how the cells should be ordered, and if paging or filtering in the table should be taken into account.

method invalidate

invalidate: (source?: string) => Api;

• Invalidate the data held in DataTables for the selected cells

  Parameter source

  Data source to read the new data from.

method render

render: (t: string) => any;

• Get data for the selected cell

  Parameter f

  Data type to get. This can be one of: 'display', 'filter', 'sort', 'type'

method footer

footer: () => HTMLElement;

• Get the footer th / td cell for the selected column.

method header

header: () => HTMLElement;

• Get the header th / td cell for a column.

method order

order: (direction: string) => Api;

• Order the table, in the direction specified, by the column selected by the column()DT selector.

  Parameter direction

  Direction of sort to apply to the selected column - desc (descending) or asc (ascending).

method visible

visible: { (): boolean; (show: boolean, redrawCalculations?: boolean): Api };

• Get the visibility of the selected column.

• Set the visibility of the selected column.

  Parameter show

  Specify if the column should be visible (true) or not (false).

  Parameter redrawCalculations

  Indicate if DataTables should recalculate the column layout (true - default) or not (false).

method invalidate

invalidate: (source?: string) => Api;

• Obtain the th / td nodes for the selected column

  Parameter source

  Data source to read the new data from. Values: 'auto', 'data', 'dom'

method cache

cache: (t: string) => Api;

• Get the DataTables cached data for the selected cell

  Parameter t

  Specify which cache the data should be read from. Can take one of two values: search or order

property ajax

ajax: AjaxMethodModel;

• Ajax Methods

property page

page: PageMethods;

• Page Methods / object

property state

state: StateMethods;

• Page Methods / object

method $

$: (
    selector: string | Node | Node[] | JQuery,
    modifier?: ObjectSelectorModifier
) => JQuery;

• Get jquery object

method clear

clear: () => Api;

• Clear the table of all data.

method destroy

destroy: (remove?: boolean) => Api;

• Destroy the DataTables in the current context.

  Parameter remove

  Completely remove the table from the DOM (true) or leave it in the DOM in its original plain un-enhanced HTML state (default, false).

method draw

draw: (paging?: boolean | string) => Api;

• Redraw the DataTables in the current context, optionally updating ordering, searching and paging as required.

  Parameter paging

  This parameter is used to determine what kind of draw DataTables will perform.

method i18n

i18n: (token: string, def: any, numeric?: number) => string;

method init

init: () => Settings;

method off

off: (event: string, callback?: (e: Event, ...args: any[]) => void) => Api;

• Table events removal.

  Parameter event

  Event name to remove.

  Parameter callback

  Specific callback function to remove if you want to unbind a single event listener.

method on

on: (event: string, callback: (e: Event, ...args: any[]) => void) => Api;

• Table events listener.

  Parameter event

  Event to listen for.

  Parameter callback

  Specific callback function to remove if you want to unbind a single event listener.

method one

one: (event: string, callback: (e: Event, ...args: any[]) => void) => Api;

• Listen for a table event once and then remove the listener.

  Parameter event

  Event to listen for.

  Parameter callback

  Specific callback function to remove if you want to unbind a single event listener.

method search

search: {
    (): string;
    (input: string, regex?: boolean, smart?: boolean, caseInsen?: boolean): Api;
};

• Get current search

• Search for data in the table.

  Parameter input

  Search string to apply to the table.

  Parameter regex

  Treat as a regular expression (true) or not (default, false).

  Parameter smart

  Perform smart search.

  Parameter caseInsen

  Do case-insensitive matching (default, true) or not (false).

method settings

settings: () => Api;

• Obtain the table's settings object

index signature

[index: number]: Api;

property sFilter

sFilter?: string | undefined;

• Default Value: dataTables_filter

property sFilterInput

sFilterInput?: string | undefined;

property sFooterTH

sFooterTH?: string | undefined;

property sHeaderTH

sHeaderTH?: string | undefined;

property sInfo

sInfo?: string | undefined;

• Default Value: dataTables_info

property sJUIFooter

sJUIFooter?: string | undefined;

property sJUIHeader

sJUIHeader?: string | undefined;

property sLength

sLength?: string | undefined;

• Default Value: dataTables_length

property sLengthSelect

sLengthSelect?: string | undefined;

property sNoFooter

sNoFooter?: string | undefined;

• Default Value: no-footer

property sPageButton

sPageButton?: string | undefined;

• Default Value: paginate_button

property sPageButtonActive

sPageButtonActive?: string | undefined;

• Default Value: current

property sPageButtonDisabled

sPageButtonDisabled?: string | undefined;

• Default Value: disabled

property sPaging

sPaging?: string | undefined;

• Default Value: dataTables_paginate paging_

property sProcessing

sProcessing?: string | undefined;

• Default Value: dataTables_processing

property sRowEmpty

sRowEmpty?: string | undefined;

• Default Value: dataTables_empty

property sScrollBody

sScrollBody?: string | undefined;

• Default Value: dataTables_scrollBody

property sScrollFoot

sScrollFoot?: string | undefined;

• Default Value: dataTables_scrollFoot

property sScrollFootInner

sScrollFootInner?: string | undefined;

• Default Value: dataTables_scrollFootInner

property sScrollHead

sScrollHead?: string | undefined;

• Default Value: dataTables_scrollHead

property sScrollHeadInner

sScrollHeadInner?: string | undefined;

• Default Value: dataTables_scrollHeadInner

property sScrollWrapper

sScrollWrapper?: string | undefined;

• Default Value: dataTables_scroll

property sSortable

sSortable?: string | undefined;

• Default Value: sorting

property sSortableAsc

sSortableAsc?: string | undefined;

• Default Value: sorting_asc_disabled

property sSortableDesc

sSortableDesc?: string | undefined;

• Default Value: sorting_desc_disabled

property sSortableNone

sSortableNone?: string | undefined;

• Default Value: sorting_disabled

property sSortAsc

sSortAsc?: string | undefined;

• Default Value: sorting_asc

property sSortColumn

sSortColumn?: string | undefined;

• Default Value: sorting_

property sSortDesc

sSortDesc?: string | undefined;

• Default Value: sorting_desc

property sSortIcon

sSortIcon?: string | undefined;

property sSortJUI

sSortJUI?: string | undefined;

property sSortJUIAsc

sSortJUIAsc?: string | undefined;

property sSortJUIAscAllowed

sSortJUIAscAllowed?: string | undefined;

property sSortJUIDesc

sSortJUIDesc?: string | undefined;

property sSortJUIDescAllowed

sSortJUIDescAllowed?: string | undefined;

property sSortJUIWrapper

sSortJUIWrapper?: string | undefined;

property sStripeEven

sStripeEven?: string | undefined;

• Default Value: even

property sStripeOdd

sStripeOdd?: string | undefined;

• Default Value: odd

property sTable

sTable?: string | undefined;

• Default Value: dataTable

property sWrapper

sWrapper?: string | undefined;

• Default Value: dataTables_wrapper

property afnFiltering

afnFiltering: any[];

property afnSortData

afnSortData: object;

property aoFeatures

aoFeatures: any[];

property aTypes

aTypes: any[];

property builder

builder: string;

property classes

classes: ExtClassesSettings;

property errMode

errMode: string;

property feature

feature: any[];

property iApiIndex

iApiIndex: number;

property internal

internal: object;

property legacy

legacy: object;

property oApi

oApi: object;

property ofnSearch

ofnSearch: object;

property oJUIClasses

oJUIClasses: object;

property oPagination

oPagination: object;

property order

order: object;

property oSort

oSort: object;

property oStdClasses

oStdClasses: ExtClassesSettings;

property pager

pager: object;

property renderer

renderer: object;

property search

search: any[];

property selector

selector: object;

property sVersion

sVersion: string;

property type

type: ExtTypeSettings;

• Type based plug-ins.

method fnVersionCheck

fnVersionCheck: (version: string) => string;

property detect

detect: FunctionExtTypeSettingsDetect[];

• Type detection functions for plug-in development.

  See Also

  • https://datatables.net/manual/plug-ins/type-detection

property order

order: object;

• Type based ordering functions for plug-in development.

  See Also

  • https://datatables.net/manual/plug-ins/sorting {}

property search

search: object;

• Type based search formatting for plug-in development.

  {}

  Example 1

  $.fn.dataTable.ext.type.search['title-numeric'] = function ( d ) { return d.replace(/\n/g," ").replace( /<.*?>/g, "" ); }

property bAutoWidth

bAutoWidth: boolean;

property bDeferRender

bDeferRender: boolean;

property bFilter

bFilter: boolean;

property bInfo

bInfo: boolean;

property bLengthChange

bLengthChange: boolean;

property bPaginate

bPaginate: boolean;

property bProcessing

bProcessing: boolean;

property bServerSide

bServerSide: boolean;

property bSort

bSort: boolean;

property bSortClasses

bSortClasses: boolean;

property bStateSave

bStateSave: boolean;

call signature

(row: any, t: 'set', s: any, meta: CellMetaSettings): void;

call signature

(
    row: any,
    t: 'display' | 'sort' | 'filter' | 'type',
    s: undefined,
    meta: CellMetaSettings
): any;

method api

api: () => Api;

• Returns DataTables API instance Usage: $( selector ).dataTable().api();

property sSortAscending

sSortAscending?: string | undefined;

property sSortDescending

sSortDescending?: string | undefined;

property paginate

paginate?: LanguagePaginateSettings | undefined;

property sortAscending

sortAscending: string;

property sortDescending

sortDescending: string;

property oAria

oAria?: LanguageAriaLegacy | undefined;

property oPaginate

oPaginate?: LanguagePaginateLegacy | undefined;

property sEmptyTable

sEmptyTable?: string | undefined;

property sInfo

sInfo?: string | undefined;

property sInfoEmpty

sInfoEmpty?: string | undefined;

property sInfoFiltered

sInfoFiltered?: string | undefined;

property sInfoPostFix

sInfoPostFix?: string | undefined;

property sInfoThousands

sInfoThousands?: string | undefined;

property sLengthMenu

sLengthMenu?: string | undefined;

property sLoadingRecords

sLoadingRecords?: string | undefined;

property sProcessing

sProcessing?: string | undefined;

property sSearch

sSearch?: string | undefined;

property sUrl

sUrl?: string | undefined;

property sZeroRecords

sZeroRecords?: string | undefined;

property sFirst

sFirst?: string | undefined;

property sLast

sLast?: string | undefined;

property sNext

sNext?: string | undefined;

property sPrevious

sPrevious?: string | undefined;

property first

first: string;

property last

last: string;

property next

next: string;

property previous

previous: string;

property aria

aria?: LanguageAriaSettings | undefined;

property decimal

decimal?: string | undefined;

property emptyTable

emptyTable?: string | undefined;

property info

info?: string | undefined;

property infoEmpty

infoEmpty?: string | undefined;

property infoFiltered

infoFiltered?: string | undefined;

property infoPostFix

infoPostFix?: string | undefined;

property lengthMenu

lengthMenu?: string | undefined;

property loadingRecords

loadingRecords?: string | undefined;

property paginate

paginate?: LanguagePaginateSettings | undefined;

property processing

processing?: string | undefined;

property search

search?: string | undefined;

property searchPlaceholder

searchPlaceholder?: string | undefined;

property thousands

thousands?: string | undefined;

property url