datatables.net 1.13.8 → 2.0.0

package/types/types.d.ts

@@ -13,8 +13,13 @@
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  * Types
  */
-// No publicly documented properties
-type InternalSettings = Object;
+
+/**
+ * DataTable's internal settings object. DO NOT USE! The parameters
+ * in this object are considered private. They can, do, and will
+ * change! Always use the API methods for manipulating the table.
+ */
+export type InternalSettings = {[key: string]: any};
 
 export type DomSelector =
     string |
@@ -62,6 +67,124 @@ export type CellIdxWithVisible = {
     columnVisible: number;
 }
 
+export type SearchInput<T> = string | RegExp | ((data: string, rowData: T) => boolean);
+export type SearchInputColumn<T> = string | RegExp | ((data: string, rowData: T, column: number) => boolean);
+
+export type HeaderStructure = {
+    cell: HTMLElement;
+    colspan: number;
+    rowspan: number;
+    title: string;
+}
+
+/**
+ * DataTables search options.
+ * 
+ * @see https://datatables.net/reference/type/DataTables.SearchOptions
+ */
+export interface SearchOptions {
+    /** Match from the start of words (ASCII) */
+	boundary?: boolean,
+
+    /** Case insensitive search */
+	caseInsensitive?: boolean,
+
+    /** Exact matching */
+	exact?: boolean,
+
+    /** Treat the input as regex (true) or not (false) */
+	regex?: boolean,
+
+    /** Use DataTables smart search */
+	smart?: boolean
+}
+
+export interface OrderIdx {
+	idx: number;
+	dir: 'asc' | 'desc';
+}
+
+export interface OrderName {
+	name: string;
+	dir: 'asc' | 'desc';
+}
+
+export type OrderArray = [number, 'asc' | 'desc'];
+
+export type OrderCombined = OrderIdx | OrderName | OrderArray;
+
+export type Order = OrderCombined | OrderCombined[];
+
+export interface DataType {
+    className?: string;
+    detect?: ((data: any) => string);
+    order?: {
+        pre?: ((a: any, b: any) => number);
+        asc?: ((a: any, b: any) => number);
+        desc?: ((a: any, b: any) => number);
+    }
+    render?: ((data: any, type: string, row: any) => string | number | HTMLElement);
+    search?: ((data: any) => string);
+}
+
+export interface Feature {
+    /** Table information display */
+    info?: {
+        /** Information display callback */
+        callback?: (settings: InternalSettings, start: number, end: number, max: number, total: number, pre: string) => string;
+
+        /** Empty table text */
+        empty?: string;
+
+        /** Information string postfix */
+        postfix?: string;
+
+        /** Appended to the info string when searching is active */
+        search?: string;
+
+        /** Table summary information display string */
+        text?: string;
+    }
+
+    /** Paging length control */
+    pageLength?: {
+        /** Text for page length control */
+        menu?: Array<number | {label: string; value: number}>;
+
+        /** Text for page length control */
+        text?: string;
+    }
+
+    /** Pagination buttons */
+    paging?: {
+        /** Paging button display options */
+        type?: 'numbers' | 'simple' | 'simple_numbers' | 'full' | 'full_numbers' | 'first_last_numbers';
+
+        /** Set the maximum number of paging number buttons */
+        numbers?: number;
+    }
+
+    /** Global search input */
+    search?: {
+        /** Placeholder for the input element */
+        placeholder?: string;
+
+        /** Text for search control */
+        text?: string;
+    }
+}
+
+type LayoutNumber = '' | '1' | '2' | '3' | '4' | '5';
+
+type LayoutSide = 'top' | 'bottom';
+
+type LayoutEdge = 'Start' | 'End';
+
+type LayoutKeys = `${LayoutSide}${LayoutNumber}${LayoutEdge}` | `${LayoutSide}${LayoutNumber}`;
+
+type Layout = Partial<Record<LayoutKeys, keyof Feature | Feature | Array<keyof Feature> | Feature[]>>;
+
+
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  * Main interfaces
  */
@@ -143,6 +266,12 @@ export interface Config {
      */
     autoWidth?: boolean;
 
+    /**
+     * Set a `caption` for the table. This can be used to describe the contents
+     * of the table to the end user. A caption tag can also be read from HTML.
+     */
+    caption?: string;
+
     /**
      * Data to use as the display data for the table.
      */
@@ -180,6 +309,8 @@ export interface Config {
 
     /**
      * Define the table control elements to appear on the page and in what order.
+     * 
+     * @deprecated Use `layout` instead
      */
     dom?: string;
 
@@ -193,6 +324,11 @@ export interface Config {
      */
     language?: ConfigLanguage;
 
+    /**
+     * 
+     */
+    layout?: Layout;
+
     /**
      * Feature control the end user's ability to change the paging display length of the table.
      */
@@ -216,12 +352,15 @@ export interface Config {
     /**
      * Initial order (sort) to apply to the table.
      */
-    order?: Array<(number | string)> | Array<Array<(number | string)>>;
+    order?: Order | Order[];
 
     /**
      * Ordering to always be applied to the table.
      */
-    orderFixed?: Array<(number | string)> | Array<Array<(number | string)>> | object;
+    orderFixed?: Order | Order[] | {
+        pre?: Order | Order[],
+        post: Order | Order[]
+    };
 
     /**
      * Feature control ordering (sorting) abilities in DataTables.
@@ -402,6 +541,7 @@ export interface Config {
 
 export interface ConfigLanguage {
     emptyTable?: string;
+    entries?: string | object;
     info?: string;
     infoEmpty?: string;
     infoFiltered?: string;
@@ -470,6 +610,11 @@ export interface ConfigColumns {
      */
     defaultContent?: string;
 
+    /**
+     * Text to display in the table's footer for this column.
+     */
+    footer?: string;
+
     /**
      * Set a descriptive name for a column.
      */
@@ -502,7 +647,7 @@ export interface ConfigColumns {
     /**
      * Order direction application sequence.
      */
-    orderSequence?: string[];
+    orderSequence?: Array<'asc' | 'desc' | ''>;
 
     /**
      * Render (process) the data for use in the table.
@@ -588,7 +733,7 @@ export interface ConfigSearch {
  * API
  */
 
-export interface Api<T> {
+export interface Api<T=any> {
     /**
      * API should be array-like
      */
@@ -621,6 +766,23 @@ export interface Api<T> {
      */
     any(): boolean;
 
+    /**
+     * Get the contents of the `caption` element for the table.
+     */
+    caption(): string;
+
+    /**
+     * Set the contents of the `-tag caption` element. If the table doesn't have 
+     * a `-tag caption` element, one will be created automatically.
+     * 
+     * @param string The value to show in the table's `caption` tag.
+     * @param side `top` or `bottom` to set where the table will be shown on the
+     *   table. If not given the previous value will be used (can also be set in
+     *   CSS).
+     * @returns DataTables API instance for chaining.
+     */
+    caption(set: string, side?: 'top' | 'bottom'): Api<T>;
+
     /**
      * Cell (single) selector and methods
      */
@@ -641,7 +803,7 @@ export interface Api<T> {
     /**
      * Column Methods / object
      */
-    column: ApiColumn;
+    column: ApiColumn<T>;
 
     /**
      * Columns Methods / object
@@ -657,6 +819,13 @@ export interface Api<T> {
      */
     concat(a: object, ...b: object[]): Api<any>;
 
+    /**
+     * The table setting objects that are manipulated by this API instance
+     * 
+     * @private
+     */
+    context: InternalSettings[],
+
     /**
      * Get the number of entries in an API instance's result set, regardless of multi-table grouping (e.g. any data, selected rows, etc). Since: 1.10.8
      * 
@@ -703,6 +872,13 @@ export interface Api<T> {
      */
     eq(idx: number): Api<any>;
 
+    /**
+     * Show an error message to the end user / developer through the DataTables logging settings.
+     *
+     * @param msg Error message to show
+     */
+    error(msg: string): Api<T>;
+
     /**
      * Iterate over the result set of an API instance and test each item, creating a new instance from those items which pass.
      *
@@ -752,13 +928,13 @@ export interface Api<T> {
      * @param returns Indicate if the callback function will return values or not. If set to true a new API instance will be returns with the return values from the callback function in its result set. If not set, or false the original instance will be returned for chaining, if no values are returned by the callback method.
      * @returns Original API instance if the callback returns no result (i.e. undefined) or a new API instance with the result set being the results from the callback, in order of execution.
      */
-    iterator(type: 'table', callback: InteratorTable, returns: boolean): Api<any>;
-    iterator(type: 'cell', callback: InteratorCell, returns: boolean): Api<any>;
-    iterator(type: 'column-rows', callback: InteratorColumnRows, returns: boolean): Api<any>;
-    iterator(type: 'column', callback: InteratorColumn, returns: boolean): Api<any>;
-    iterator(type: 'columns', callback: InteratorColumns, returns: boolean): Api<any>;
-    iterator(type: 'row', callback: InteratorRow, returns: boolean): Api<any>;
-    iterator(type: 'rows', callback: InteratorRows, returns: boolean): Api<any>;
+    iterator(type: 'table', callback: InteratorTable, returns?: boolean): Api<any>;
+    iterator(type: 'cell', callback: InteratorCell, returns?: boolean): Api<any>;
+    iterator(type: 'column-rows', callback: InteratorColumnRows, returns?: boolean): Api<any>;
+    iterator(type: 'column', callback: InteratorColumn, returns?: boolean): Api<any>;
+    iterator(type: 'columns', callback: InteratorColumns, returns?: boolean): Api<any>;
+    iterator(type: 'row', callback: InteratorRow, returns?: boolean): Api<any>;
+    iterator(type: 'rows', callback: InteratorRows, returns?: boolean): Api<any>;
 
     /**
      * Iterate over a result set of table, row, column or cell indexes
@@ -769,13 +945,13 @@ export interface Api<T> {
      * @param returns Indicate if the callback function will return values or not. If set to true a new API instance will be returns with the return values from the callback function in its result set. If not set, or false the original instance will be returned for chaining, if no values are returned by the callback method.
      * @returns Original API instance if the callback returns no result (i.e. undefined) or a new API instance with the result set being the results from the callback, in order of execution.
      */
-    iterator(flatten: boolean, type: 'table', callback: InteratorTable, returns: boolean): Api<any>;
-    iterator(flatten: boolean, type: 'cell', callback: InteratorCell, returns: boolean): Api<any>;
-    iterator(flatten: boolean, type: 'column-rows', callback: InteratorColumnRows, returns: boolean): Api<any>;
-    iterator(flatten: boolean, type: 'column', callback: InteratorColumn, returns: boolean): Api<any>;
-    iterator(flatten: boolean, type: 'columns', callback: InteratorColumns, returns: boolean): Api<any>;
-    iterator(flatten: boolean, type: 'row', callback: InteratorRow, returns: boolean): Api<any>;
-    iterator(flatten: boolean, type: 'rows', callback: InteratorRows, returns: boolean): Api<any>;
+    iterator(flatten: boolean, type: 'table', callback: InteratorTable, returns?: boolean): Api<any>;
+    iterator(flatten: boolean, type: 'cell', callback: InteratorCell, returns?: boolean): Api<any>;
+    iterator(flatten: boolean, type: 'column-rows', callback: InteratorColumnRows, returns?: boolean): Api<any>;
+    iterator(flatten: boolean, type: 'column', callback: InteratorColumn, returns?: boolean): Api<any>;
+    iterator(flatten: boolean, type: 'columns', callback: InteratorColumns, returns?: boolean): Api<any>;
+    iterator(flatten: boolean, type: 'row', callback: InteratorRow, returns?: boolean): Api<any>;
+    iterator(flatten: boolean, type: 'rows', callback: InteratorRows, returns?: boolean): Api<any>;
 
     /**
      * Join the elements in the result set into a string.
@@ -829,7 +1005,7 @@ export interface Api<T> {
      * Table events listener.
      *
      * @param event Event to listen for.
-     * @param callback Specific callback function to remove if you want to unbind a single event listener.
+     * @param callback Event handler.
      * @returns DataTables Api instance
      */
     on(event: string, callback: ((this: HTMLElement, e: Event, ...args: any[]) => void)): Api<T>;
@@ -848,7 +1024,7 @@ export interface Api<T> {
      * Listen for a table event once and then remove the listener.
      *
      * @param event Event to listen for.
-     * @param callback Specific callback function to remove if you want to unbind a single event listener.
+     * @param callback Event handler.
      * Listen for events from tables and fire a callback when they occur
      * @returns DataTables Api instance
      */
@@ -864,6 +1040,11 @@ export interface Api<T> {
      */
     one(event: string, selector: string, callback: ((this: HTMLElement, e: Event, ...args: any[]) => void)): Api<T>;
 
+    /**
+     * Order Methods / object
+     */
+    order: ApiOrder;
+
     /**
      * Page Methods / object
      */
@@ -893,9 +1074,16 @@ export interface Api<T> {
     push(value_1: any, ...value_2: any[]): number;
 
     /**
-     * Order Methods / object
+     * Determine if the DataTable is ready or not
      */
-    order: ApiOrder;
+    ready(): boolean;
+
+    /**
+     * Execute a function when the DataTable becomes ready (or immediately if it already is)
+     *
+     * @param fn Function to execute
+     */
+    ready(fn: ((this: Api<T>) => void)): Api<T>;
 
     /**
      * Apply a callback function against and accumulator and each element in the Api's result set (left-to-right).
@@ -933,22 +1121,9 @@ export interface Api<T> {
     rows: ApiRows<T>;
 
     /**
-     * Get current search
-     * 
-     * @returns The currently applied global search. This may be an empty string if no search is applied.
-     */
-    search(): string;
-
-    /**
-     * Set the global search to use on the table. Note this doesn't actually perform the search.
-     *
-     * @param input Search string to apply to the table.
-     * @param regex Treat as a regular expression (true) or not (default, false).
-     * @param smart Perform smart search.
-     * @param caseInsen Do case-insensitive matching (default, true) or not (false).
-     * @returns DataTables API instance
+     * Search Methods / object
      */
-    search(input: string, regex?: boolean, smart?: boolean, caseInsen?: boolean): Api<any>;
+    search: ApiSearch<T>;
 
     /**
      * Obtain the table's settings object
@@ -1032,7 +1207,19 @@ export interface Api<T> {
     toJQuery(): JQuery;
 
     /**
-     * Create a new API instance containing only the unique items from a the elements in an instance's result set.
+     * Trigger a DataTables related event.
+     *
+     * @param name The event name.
+     * @param args An array of the arguments to send to the event.
+     * @param bubbles Indicate if the event should bubble up the document in the
+     *   same way that DOM events usually do, or not. There is a performance
+     *   impact for bubbling events.
+     * @returns Api instance for chaining
+     */
+    trigger( name: string, args: any[], bubbles?: boolean): Api<T>;
+
+    /**
+     * Create a new API instance containing only the unique items from the elements in an instance's result set.
      * 
      * @returns New Api instance which contains the unique items from the original instance's result set, in its own result set.
      */
@@ -1050,10 +1237,11 @@ export interface Api<T> {
 
 export interface ApiSelectorModifier {
     /**
-     * The order modifier provides the ability to control which order the rows are processed in.
-     * Values: 'current', 'applied', 'index',  'original'
+     * The order modifier provides the ability to control which order the rows are
+     * processed in. Can be one of 'current', 'applied', 'index', 'original', or
+     * the column index that you want the order to be applied from.
      */
-    order?: string;
+    order?: string | number;
 
     /**
      * The search modifier provides the ability to govern which rows are used by the selector using the search options that are applied to the table.
@@ -1084,7 +1272,59 @@ export interface AjaxMethods extends Api<any> {
     load(callback?: ((json: any) => void), resetPaging?: boolean): Api<any>;
 }
 
+export interface ApiSearch<T> {
+    /**
+     * Get current search
+     * 
+     * @returns The currently applied global search. This may be an empty string if no search is applied.
+     */
+    (): SearchInput<T>;
+
+    /**
+     * Set the global search to use on the table. Note this doesn't actually perform the search.
+     *
+     * @param input Search string to apply to the table.
+     * @param regex Treat as a regular expression (true) or not (default, false).
+     * @param smart Perform smart search.
+     * @param caseInsen Do case-insensitive matching (default, true) or not (false).
+     * @returns DataTables API instance
+     */
+    (input: SearchInput<T>, regex?: boolean, smart?: boolean, caseInsen?: boolean): Api<any>;
+
+    /**
+     * Set the global search to use on the table. Note this doesn't actually perform the search.
+     *
+     * @param input Search string to apply to the table.
+     * @param options Configuration options for how the search should be performed
+     * @returns DataTables API instance
+     */
+    (input: SearchInput<T>, options: SearchOptions): Api<any>;
 
+    /**
+     * Get a list of the names of searches applied to the table.
+     * 
+     * @returns API instance containing the fixed search terms
+     */
+    fixed(): Api<string>;
+    
+    /**
+     * Get the search term used for the given name.
+     *
+     * @param name Fixed search term to get.
+     * @returns The search term for the name given or undefined if not set.
+     */
+    fixed( name: string ): SearchInput<T> | undefined;
+    
+    /**
+     * Set a search term to apply to the table, using a name to uniquely identify it.
+     *
+     * @param name Name to give the fixed search term
+     * @param search The search term to apply to the table or `null` to delete
+     *   an existing search term by the given name.
+     * @returns API for chaining
+     */
+    fixed( name: string, search: SearchInput<T> | null ): Api<T>;
+}
 
 
 export interface ApiPageInfo {
@@ -1263,7 +1503,7 @@ export interface ApiOrder {
      * 
      * @returns Array of arrays containing information about the currently applied sort. This 2D array is the same format as the array used for setting the order to apply to the table
      */
-    (): Array<Array<(string | number)>>;
+    (): OrderArray[];
 
     /**
      * Set the ordering applied to the table.
@@ -1271,8 +1511,8 @@ export interface ApiOrder {
      * @param order Order Model
      * @returns DataTables Api instance
      */
-    (order?: Array<(string | number)> | Array<Array<(string | number)>>): Api<any>;
-    (order: Array<(string | number)>, ...args: any[]): Api<any>;
+    (order?: Order | Order[]): Api<any>;
+    (order: Order, ...args: Order[]): Api<any>;
 
     /**
      * Get the fixed ordering that is applied to the table. If there is more than one table in the API's context,
@@ -1337,7 +1577,7 @@ export interface ApiCell<T> {
      * Select the cell found by a cell selector
      *
      * @param cellSelector Cell selector.
-     * @param Option used to specify how the cells should be ordered, and if paging or filtering
+     * @param modifier Option used to specify how the cells should be ordered, and if paging or filtering
      * @returns DataTables API instance with selected cell
      */
     (cellSelector: CellSelector, modifier?: ApiSelectorModifier): ApiCellMethods<T>;
@@ -1347,10 +1587,10 @@ export interface ApiCell<T> {
      *
      * @param rowSelector Row selector.
      * @param columnSelector Column selector.
-     * @param Option used to specify how the cells should be ordered, and if paging or filtering
+     * @param modifier Option used to specify how the cells should be ordered, and if paging or filtering
      * @returns DataTables API instance with selected cell
      */
-    (rowSelector: CellSelector, columnSelector: any, modifier?: ApiSelectorModifier): ApiCellMethods<T>;
+    (rowSelector: RowSelector<T>, columnSelector: ColumnSelector, modifier?: ApiSelectorModifier): ApiCellMethods<T>;
 }
 
 export interface ApiCellMethods<T> extends Omit<Api<T>, 'render'> {
@@ -1412,7 +1652,7 @@ export interface ApiCells<T> {
     /**
      * Select all cells
      *
-     * @param Option used to specify how the cells should be ordered, and if paging or filtering
+     * @param modifier Option used to specify how the cells should be ordered, and if paging or filtering
      * @returns DataTables API instance with selected cells
      */
     (modifier?: ApiSelectorModifier): ApiCellsMethods<T>;
@@ -1421,7 +1661,7 @@ export interface ApiCells<T> {
      * Select cells found by a cell selector
      *
      * @param cellSelector Cell selector.
-     * @param Option used to specify how the cells should be ordered, and if paging or filtering
+     * @param modifier Option used to specify how the cells should be ordered, and if paging or filtering
      * @returns DataTables API instance with selected cells
      */
     (cellSelector: CellSelector, modifier?: ApiSelectorModifier): ApiCellsMethods<T>;
@@ -1431,10 +1671,10 @@ export interface ApiCells<T> {
      *
      * @param rowSelector Row selector.
      * @param columnSelector Column selector.
-     * @param Option used to specify how the cells should be ordered, and if paging or filtering
+     * @param modifier Option used to specify how the cells should be ordered, and if paging or filtering
      * @returns DataTables API instance with selected cells
      */
-    (rowSelector: RowSelector<T>, columnSelector: CellSelector, modifier?: ApiSelectorModifier): ApiCellsMethods<T>;
+    (rowSelector: RowSelector<T>, columnSelector: ColumnSelector, modifier?: ApiSelectorModifier): ApiCellsMethods<T>;
 }
 
 export interface ApiCellsMethods<T> extends Omit<Api<T>, 'data' | 'render'> {
@@ -1485,19 +1725,53 @@ export interface ApiCellsMethods<T> extends Omit<Api<T>, 'data' | 'render'> {
      * @returns Rendered data for the requested type
      */
     render(type: string): any;
+
+    /**
+     * Get the title text for a column
+     *
+     * @param row Indicate which row in the header the title should be read from
+     *  when working with multi-row headers.
+     * @return Column title
+     */
+    title( row?: number ): string;
+
+    /**
+     * Set the title text for a column
+     *
+     * @param title Title to set
+     * @param row Indicate which row in the header the title should be read from
+     *  when working with multi-row headers.
+     * @return DataTables API instance for chaining
+     */
+    title( title: string, row?: number ): Api<T>;
+
+    /**
+     * Get the column's data type (auto detected or configured).
+     * 
+     * @return The column's data type.
+     */
+    type(): string;
+
+    /**
+     * Compute the width of a column as it is shown.
+     * 
+     * @return The width of the column in pixels or `null` if there is no data
+     *   in the table.
+     */
+    width(): number | null;
 }
 
 
 
 
-export interface ApiColumn {
+export interface ApiColumn<T> {
     /**
      * Select the column found by a column selector
      *
-     * @param cellSelector Cell selector.
-     * @param Option used to specify how the cells should be ordered, and if paging or filtering in the table should be taken into account.
+     * @param columnSelector Column selector.
+     * @param modifier Option used to specify how the cells should be ordered, and if paging or filtering in the table should be taken into account.
      */
-    (columnSelector: ColumnSelector, modifier?: ApiSelectorModifier): ApiColumnMethods;
+    (columnSelector: ColumnSelector, modifier?: ApiSelectorModifier): ApiColumnMethods<T>;
 
     /**
      * Convert from the input column index type to that required.
@@ -1509,7 +1783,7 @@ export interface ApiColumn {
     index(type: string, index: number): number;
 }
 
-export interface ApiColumnMethods {
+export interface ApiColumnMethods<T> extends Omit<Api<T>, 'init' | 'data' | 'order' | 'render' | 'search'> {
     /**
      * Get the DataTables cached data for the selected column(s)
      *
@@ -1533,18 +1807,22 @@ export interface ApiColumnMethods {
     dataSrc(): number | string | (() => string);
 
     /**
-     * Get the footer th / td cell for the selected column(s).
+     * Get the footer th / td cell for the selected column.
      * 
-     * @returns HTML element for the footer of the column(s)
+     * @param row Indicate which row in the footer the cell should be read from
+     *  when working with multi-row footers.
+     * @returns HTML element for the footer of the column
      */
-    footer(): HTMLElement;
+    footer(row?: number): HTMLElement;
 
     /**
-     * Get the header th / td cell for a column(s).
+     * Get the header th / td cell for a column.
      * 
-     * @returns HTML element for the header of the column(s)
+     * @param row Indicate which row in the header the cell should be read from
+     *  when working with multi-row headers.
+     * @returns HTML element for the header of the column
      */
-    header(): HTMLElement;
+    header(row?: number): HTMLElement;
 
     /**
      * Get the column index of the selected column.
@@ -1554,6 +1832,13 @@ export interface ApiColumnMethods {
      */
     index(type?: string): number;
 
+    /**
+     * Get the initialisation object used for the selected column.
+     *
+     * @returns Column configuration object
+     */
+    init(): ConfigColumns;
+
     /**
      * Obtain the th / td nodes for the selected column
      * 
@@ -1570,22 +1855,52 @@ export interface ApiColumnMethods {
     order(direction: string): Api<any>;
 
     /**
-     * Get the currently applied column search.
-     * 
-     * @returns the currently applied column search.
+     * Get the orderable state for the column (from `columns.orderable`).
      */
-    search(): string;
+    orderable(): boolean;
 
     /**
-     * Set the search term for the matched columns.
+     * Get a list of the column ordering directions (from `columns.orderSequence`).
+     */
+    orderable(directions: true): Api<string>;
+
+    /**
+     * Get rendered data for the selected column.
+     * @param type Data type to get. Typically `display`, `filter`, `sort` or `type`
+     *   although can be anything that the rendering functions expect.
+     */
+    render(type?: string): Api<T>;
+
+    /**
+     * Search methods and properties
+     */
+    search: ApiColumnSearch<T>;
+
+    /**
+     * Get the title text for the selected column
      *
-     * @param input Search string to apply.
-     * @param regex Treat as a regular expression (true) or not (default, false).
-     * @param smart Perform smart search.
-     * @param caseInsen Do case-insensitive matching (default, true) or not (false).
-     * @returns DataTables API instance
+     * @param row Indicate which row in the header the title should be read from
+     *  when working with multi-row headers.
+     * @return Column titles in API instance's data set
+     */
+    title( row?: number ): string;
+
+    /**
+     * Set the title text for the selected column
+     *
+     * @param title Title to set
+     * @param row Indicate which row in the header the title should be read from
+     *  when working with multi-row headers.
+     * @return DataTables API instance for chaining
      */
-    search(input: string, regex?: boolean, smart?: boolean, caseInsen?: boolean): Api<any>;
+    title( title: string, row?: number ): Api<T>;
+
+    /**
+     * Get the data type for the selected column (auto detected or configured).
+     * 
+     * @return DataTables API instance with column types in its data set
+     */
+    type(): string;
 
     /**
      * Get the visibility of the selected column.
@@ -1602,25 +1917,87 @@ export interface ApiColumnMethods {
      * @returns DataTables API instance with selected column in the result set.
      */
     visible(show: boolean, redrawCalculations?: boolean): Api<any>;
+
+    /**
+     * Compute the width of the selected column as they are shown.
+     * 
+     * @return Api instance with the width of each column in pixels or `null` if
+     *   there is no data in the table.
+     */
+    width(): number | null;
+}
+
+export interface ApiColumnSearch<T> {
+    /**
+     * Get the currently applied column search.
+     * 
+     * @returns the currently applied column search.
+     */
+    (): string;
+
+    /**
+     * Set the search term for the matched column.
+     *
+     * @param input Search apply.
+     * @param regex Treat as a regular expression (true) or not (default, false).
+     * @param smart Perform smart search.
+     * @param caseInsen Do case-insensitive matching (default, true) or not (false).
+     * @returns DataTables API instance
+     */
+    (input: SearchInputColumn<T>, regex?: boolean, smart?: boolean, caseInsen?: boolean): Api<any>;
+
+    /**
+     * Set the search term for the matched column.
+     *
+     * @param input Search to apply.
+     * @param Search Search configuration options
+     * @returns DataTables API instance
+     */
+    (input: SearchInputColumn<T>, options: SearchOptions): Api<any>;
+
+    /**
+     * Get a list of the names of searches applied to the column
+     * 
+     * @returns API instance containing the column's fixed search terms
+     */
+    fixed(): Api<string>;
+    
+    /**
+     * Get the search term for the column used for the given name.
+     *
+     * @param name Fixed search term to get.
+     * @returns The search term for the name given or undefined if not set.
+     */
+    fixed( name: string ): SearchInputColumn<T> | undefined;
+    
+    /**
+     * Set a search term to apply to the column, using a name to uniquely identify it.
+     *
+     * @param name Name to give the fixed search term
+     * @param search The search term to apply to the column or `null` to delete
+     *   an existing search term by the given name.
+     * @returns API for chaining
+     */
+    fixed( name: string, search: SearchInputColumn<T> | null ): Api<T>;
 }
 
 export interface ApiColumns<T> {
     /**
      * Select all columns
      *
-     * @param Option used to specify how the cells should be ordered, and if paging or filtering in the table should be taken into account.
+     * @param modifier Option used to specify how the cells should be ordered, and if paging or filtering in the table should be taken into account.
      * @returns DataTables API instance with selected columns in the result set.
      */
-    (modifier?: ApiSelectorModifier): ApiColumnsMethods | Api<Array<any>>;
+    (modifier?: ApiSelectorModifier): ApiColumnsMethods<T>;
     
     /**
      * Select columns found by a cell selector
      *
-     * @param cellSelector Cell selector.
-     * @param Option used to specify how the cells should be ordered, and if paging or filtering in the table should be taken into account.
+     * @param columnSelector Column selector.
+     * @param modifier Option used to specify how the cells should be ordered, and if paging or filtering in the table should be taken into account.
      * @returns DataTables API instance with selected columns
      */
-    (columnSelector: ColumnSelector, modifier?: ApiSelectorModifier): ApiColumnsMethods;
+    (columnSelector: ColumnSelector, modifier?: ApiSelectorModifier): ApiColumnsMethods<T>;
 
     /**
      * Recalculate the column widths for layout.
@@ -1631,7 +2008,7 @@ export interface ApiColumns<T> {
 }
 
 
-export interface ApiColumnsMethods {
+export interface ApiColumnsMethods<T> extends Omit<Api<T>, 'init' | 'data' | 'order' | 'render' | 'search'> {
     /**
      * Get the DataTables cached data for the selected columna
      *
@@ -1660,14 +2037,25 @@ export interface ApiColumnsMethods {
      * @param fn Function to execute for every column selected.
      * @returns DataTables API instance of the selected columns.
      */
-    every(fn: (this: ApiColumnMethods, colIdx: number, tableLoop: number, colLoop: number) => void): Api<any>;
+    every(fn: (this: ApiColumnMethods<T>, colIdx: number, tableLoop: number, colLoop: number) => void): Api<any>;
 
     /**
-     * Get the footer th / td cell for the selected columna.
+     * Get the footer th / td cell for the selected columns.
      * 
-     * @returns HTML element for the footer of the columna
+     * @param row Indicate which row in the footer the cell should be read from
+     *  when working with multi-row footers.
+     * @returns HTML element for the footer of the columns
      */
-    footer(): HTMLElement;
+    footer(row?: number): Api<HTMLElement>;
+
+    /**
+     * Get the header th / td cell for a columns.
+     * 
+     * @param row Indicate which row in the header the cell should be read from
+     *  when working with multi-row headers.
+     * @returns HTML element for the header of the columns
+     */
+    header(row?: number): Api<HTMLElement>;
 
     /**
      * Get the column indexes of the selected columns.
@@ -1678,11 +2066,11 @@ export interface ApiColumnsMethods {
     indexes(type?: string): Api<Array<number>>;
 
     /**
-     * Get the header th / td cell for a columna.
-     * 
-     * @returns HTML element for the header of the columna
+     * Get the initialisation objects used for the selected columns.
+     *
+     * @returns Api instance of column configuration objects
      */
-    header(): HTMLElement;
+    init(): Api<ConfigColumns>;
 
     /**
      * Obtain the th / td nodes for the selected columns
@@ -1700,22 +2088,52 @@ export interface ApiColumnsMethods {
     order(direction: string): Api<any>;
 
     /**
-     * Get the currently applied columns search.
-     * 
-     * @returns the currently applied columns search.
+     * Get the orderable state for the selected columns (from `columns.orderable`).
      */
-    search(): Api<Array<string>>;
+    orderable(): Api<boolean>;
 
     /**
-     * Set the search term for the columns from the selector. Note this doesn't actually perform the search.
+     * Get a list of the column ordering directions (from `columns.orderSequence`).
+     */
+    orderable(directions: true): Api<Array<string>>;
+
+    /**
+     * Get rendered data for the selected columns.
+     * @param type Data type to get. Typically `display`, `filter`, `sort` or `type`
+     *   although can be anything that the rendering functions expect.
+     */
+    render(type?: string): Api<Array<T>>;
+
+    /**
+     * Search methods and properties
+     */
+    search: ApiColumnsSearch<T>;
+
+    /**
+     * Get the title text for the selected columns
+     *
+     * @param row Indicate which row in the header the title should be read from
+     *  when working with multi-row headers.
+     * @return Column titles in API instance's data set
+     */
+    titles( row?: number ): Api<string>;
+
+    /**
+     * Set the title text for the selected columns
+     *
+     * @param title Title to set
+     * @param row Indicate which row in the header the title should be read from
+     *  when working with multi-row headers.
+     * @return DataTables API instance for chaining
+     */
+    titles( title: string, row?: number ): Api<T>;
+
+    /**
+     * Get the data type for the selected columns (auto detected or configured).
      * 
-     * @param input Search string to apply to the selected columns.
-     * @param regex Treat as a regular expression (true) or not (default, false).
-     * @param smart Perform smart search (default, true) or not (false). 
-     * @param caseInsen Do case-insensitive matching (default, true) or not (false).
-     * @returns DataTables Api instance.
+     * @return DataTables API instance with column types in its data set
      */
-    search(input: string, regex?: boolean, smart?: boolean, caseInsen?: boolean): Api<any>;
+    types(): Api<string>;
 
     /**
      * Get the visibility of the selected columns.
@@ -1732,6 +2150,69 @@ export interface ApiColumnsMethods {
      * @returns DataTables API instance with selected columns in the result set.
      */
     visible(show: boolean, redrawCalculations?: boolean): Api<any>;
+
+    /**
+     * Compute the width of the selected columns as they are shown.
+     * 
+     * @return Api instance with the width of each column in pixels or `null` if
+     *   there is no data in the table.
+     */
+    widths(): Api<number | null>;
+}
+
+export interface ApiColumnsSearch<T> {
+    /**
+     * Get the currently applied columns search.
+     * 
+     * @returns the currently applied columns search.
+     */
+    (): Api<SearchInputColumn<T>[]>;
+
+    /**
+     * Set the search term for the columns from the selector. Note this doesn't actually perform the search.
+     * 
+     * @param input Search to apply to the selected columns.
+     * @param regex Treat as a regular expression (true) or not (default, false).
+     * @param smart Perform smart search (default, true) or not (false). 
+     * @param caseInsen Do case-insensitive matching (default, true) or not (false).
+     * @returns DataTables Api instance.
+     */
+    (input: SearchInputColumn<T>, regex?: boolean, smart?: boolean, caseInsen?: boolean): Api<any>;
+
+    /**
+     * Set the search term for the matched columns.
+     *
+     * @param input Search to apply.
+     * @param Search Search configuration options
+     * @returns DataTables API instance
+     */
+    (input: SearchInputColumn<T>, options: SearchOptions): Api<any>;
+
+    /**
+     * Get a list of the names of searches applied to the matched columns
+     * 
+     * @returns API instance containing the column's fixed search terms
+     */
+    fixed(): Api<string[]>;
+    
+    /**
+     * Get the search term for the matched columns used for the given name.
+     *
+     * @param name Fixed search term to get.
+     * @returns The search term for the name given or undefined if not set.
+     */
+    fixed( name: string ): Api<SearchInputColumn<T> | undefined>;
+
+    /**
+     * Set a search term to apply to the matched columns, using a name to
+     * uniquely identify it.
+     *
+     * @param name Name to give the fixed search term
+     * @param search The search term to apply to the column or `null` to delete
+     *   an existing search term by the given name.
+     * @returns API for chaining
+     */
+    fixed( name: string, search: SearchInputColumn<T> | null ): Api<T>;
 }
 
 
@@ -1817,7 +2298,7 @@ export interface ApiRow<T> {
      * Select a row found by a row selector
      *
      * @param rowSelector Row selector.
-     * @param Option used to specify how the cells should be ordered, and if paging or filtering in the table should be taken into account.
+     * @param modifier Option used to specify how the cells should be ordered, and if paging or filtering in the table should be taken into account.
      * @returns DataTables API instance with selected row in the result set
      */
     (rowSelector: RowSelector<T>, modifier?: ApiSelectorModifier): ApiRowMethods<T>;
@@ -1902,7 +2383,7 @@ export interface ApiRows<T> {
     /**
      * Select all rows
      *
-     * @param Option used to specify how the cells should be ordered, and if paging or filtering in the table should be taken into account.
+     * @param modifier Option used to specify how the cells should be ordered, and if paging or filtering in the table should be taken into account.
      * @returns DataTables API instance with selected rows
      */
     (modifier?: ApiSelectorModifier): ApiRowsMethods<T>;
@@ -1910,8 +2391,8 @@ export interface ApiRows<T> {
     /**
      * Select rows found by a row selector
      *
-     * @param cellSelector Row selector.
-     * @param Option used to specify how the cells should be ordered, and if paging or filtering in the table should be taken into account.
+     * @param rowSelector Row selector.
+     * @param modifier Option used to specify how the cells should be ordered, and if paging or filtering in the table should be taken into account.
      * @returns DataTables API instance with selected rows in the result set
      */
     (rowSelector: RowSelector<T>, modifier?: ApiSelectorModifier): ApiRowsMethods<T>;
@@ -1989,19 +2470,37 @@ export interface ApiRowsMethods<T> extends Api<T> {
 
 
 export interface ApiTableMethods<T> extends Api<T> {
-    /**
-     * Get the tfoot node for the table in the API's context
-     * 
-     * @returns HTML tbody node.
-     */
-    footer(): Node;
+    footer: {
+        /**
+         * Get the tfoot node for the table in the API's context
+         * 
+         * @returns HTML tbody node.
+         */
+        (): Node;
 
-    /**
-     * Get the thead node for the table in the API's context
-     * 
-     * @returns HTML thead node.
-     */
-    header(): Node;
+        /**
+         * Get an array that represents the structure of the footer
+         *
+         * @param selector Column selector
+         */
+        structure(selector?: string): HeaderStructure[][];
+    }
+
+    header: {
+        /**
+         * Get the thead node for the table in the API's context
+         * 
+         * @returns HTML thead node.
+         */
+        (): Node;
+
+        /**
+         * Get an array that represents the structure of the header
+         *
+         * @param selector Column selector
+         */
+        structure(selector?: string): HeaderStructure[][];
+    }
 
     /**
      * Get the tbody node for the table in the API's context
@@ -2054,6 +2553,14 @@ export interface ApiTablesMethods<T> extends Api<T> {
      */
     containers(): Api<Array<Node>>;
 
+    /**
+     * Iterate over each selected table, with the function context set to be the table in question. Since: DataTables 1.10.6
+     *
+     * @param fn Function to execute for every table selected.
+     */
+    every(fn: (this: ApiTableMethods<T>, tableIndex: number) => void): Api<any>;
+
+
     /**
      * Get the table nodes for the tables in the API's context
      * 
@@ -2063,28 +2570,38 @@ export interface ApiTablesMethods<T> extends Api<T> {
 }
 
 
+export interface DataTablesStatic {
+    /**
+     * Get DataTable API instance
+     *
+     * @param table Selector string for table
+     */
+    Api: ApiStatic;
 
+    /**
+     * Default Settings
+     */
+    defaults: Config;
 
+    /**
+     * Default Settings
+     */
+    ext: DataTablesStaticExt;
 
+    /** Feature control namespace */
+    feature: {
+        /**
+         * Create a new feature that can be used for layout
+         *
+         * @param name The name of the new feature.
+         * @param construct A function that will create the elements and event listeners for the feature being added.
+         */
+        register(name: string, construct: (dt: InternalSettings, options: any) => HTMLElement | JQuery): void;
+    }
 
-
-
-
-
-
-
-
-
-
-
-
-
-export interface DataTablesStatic {
     /**
      * Check if a table node is a DataTable already or not.
      *
-     * Usage:
-     * $.fn.dataTable.isDataTable("selector");
      * @param table The table to check.
      * @returns true the given table is a DataTable, false otherwise
      */
@@ -2118,38 +2635,52 @@ export interface DataTablesStatic {
     } | boolean): Array<Api<any>>| Api<any>;
 
     /**
-     * Version number compatibility check function
+     * Get the data type definition object for a specific registered data type.
      *
-     * Usage:
-     * $.fn.dataTable.versionCheck("1.10.0");
-     * @param version Version string
-     * @returns true if this version of DataTables is greater or equal to the required version, or false if this version of DataTales is not suitable
+     * @param name Data type name to get the definition of
      */
-    versionCheck(version: string): boolean;
+    type(name: string): DataType;
 
     /**
-     * Utils
+     * Set one or more properties for a specific data type.
+     *
+     * @param name Data type name to set values for
+     * @param definition Object containing the values to set
      */
-    util: DataTablesStaticUtil;
+    type(name: string, definition: DataType): void;
 
     /**
-     * Get DataTable API instance
+     * Set an individual property value for a a given data type.
      *
-     * @param table Selector string for table
+     * @param name Data type name to set a property value for
+     * @param property Name of the data type property to set
+     * @param val The value to set (typically a function or string)
      */
-    Api: ApiStatic;
+    type(name: string, property: keyof(DataType), val: any): void;
 
     /**
-     * Default Settings
+     * Get the names of the registered data types DataTables can work with.
      */
-    defaults: Config;
+    types(): string[];
 
     /**
-     * Default Settings
+     * Utils
      */
-    ext: DataTablesStaticExt;
+    util: DataTablesStaticUtil;
+
+    /**
+     * Version number compatibility check function
+     *
+     * Usage:
+     * $.fn.dataTable.versionCheck("1.10.0");
+     * @param version Version string
+     * @returns true if this version of DataTables is greater or equal to the required version, or false if this version of DataTales is not suitable
+     */
+    versionCheck(version: string): boolean;
 }
 
+export type ApiStaticRegisterFn<T> = (this: Api<T>, ...args: any[]) => any;
+
 export interface ApiStatic {
     /**
      * Create a new API instance to an existing DataTable. Note that this
@@ -2157,8 +2688,8 @@ export interface ApiStatic {
      */
     new (selector: string | Node | Node[] | JQuery | InternalSettings): Api<any>;
 
-    register<T=any>(name: string, fn: Function): T;
-    registerPlural<T=any>(pluralName: string, singleName: string, fn: Function): T;
+    register<T=any>(name: string, fn: ApiStaticRegisterFn<T>): void;
+    registerPlural<T=any>(pluralName: string, singleName: string, fn: ApiStaticRegisterFn<T>): void;
 }
 
 export interface OrderFixed {
@@ -2267,6 +2798,23 @@ export interface DataTablesStaticRender {
 }
 
 export interface DataTablesStaticUtil {
+    /**
+     * Normalise diacritic characters in a string.
+     *
+     * @param str String to have diacritic characters replaced
+     * @param appendOriginal Append the original string to the result
+     *   (`true`) or not (`false`)
+     * @returns Updated string
+     */
+    diacritics(str: string, appendOriginal?: boolean): string;
+
+    /**
+     * Set the diacritic removal function
+     *
+     * @param replacement Removal function
+     */
+    diacritics(replacement: (str: string, appendOriginal: boolean) => string): void;
+
     /**
      * Escape special characters in a regular expression string. Since: 1.10.4
      *
@@ -2275,17 +2823,47 @@ export interface DataTablesStaticUtil {
      */
     escapeRegex(str: string): string;
 
+    /**
+     * Escape entities in a string.
+     *
+     * @param str String to have HTML entities escaped
+     * @returns Sanitized string
+     */
+    escapeHtml(str: string): string;
+
+    /**
+     * Set the HTML escaping function.
+     *
+     * @param escapeFunction Function to use for HTML escaping in DataTables.
+     */
+    escapeHtml(escapeFunction: (str: string) => string): void;
+
     /**
      * Create a read function from a descriptor. Since 1.11
      * @param source A descriptor that is used to define how to read the data from the source object.
      */
-    get<T=any, D=any>(source: string | object | Function | null): ((data: D, type: string, val: T, meta: CellMetaSettings) => T);
+    get<T=any, D=any>(source: string | number | object | Function | null): ((data: D, type?: string, val?: T, meta?: CellMetaSettings) => T);
 
     /**
      * Create a write function from a descriptor. Since 1.11
      * @param source A descriptor that is used to define how to write data to a source object
      */
-    set<T=any, D=any>(source: string | object | Function | null): ((data: D, val: T, meta: CellMetaSettings) => void);
+    set<T=any, D=any>(source: string | number | object | Function | null): ((data: D, val: T, meta?: CellMetaSettings) => void);
+
+    /**
+     * Remove mark up from a string
+     *
+     * @param str String to have HTML tags stripped from.
+     * @returns Stripped string
+     */
+    stripHtml(str: string): string;
+
+    /**
+     * Set the HTML stripping function to be used by DataTables.
+     *
+     * @param stripFunction Function to use for HTML stripping in DataTables.
+     */
+    stripHtml(stripFunction: (str: string) => string): void;
 
     /**
      * Throttle the calls to a method to reduce call frequency. Since: 1.10.3
@@ -2295,6 +2873,13 @@ export interface DataTablesStaticUtil {
      * @returns Wrapper function that can be called and will automatically throttle calls to the passed in function to the given period.
      */
     throttle(fn: (data: any) => void, period?: number): (() => void);
+
+    /**
+     * Get unique values from an array.
+     * 
+     * @returns Array with unique values
+     */
+    unique<T=any>(input: Array<T>): Array<T>;
 }
 
 
@@ -2335,7 +2920,9 @@ export interface AjaxResponse {
     error?: string;
 }
 
-interface AjaxSettings extends JQueryAjaxSettings {
+export type AjaxDataSrc = string | ((data: any) => any[]);
+
+export interface AjaxSettings extends JQueryAjaxSettings {
     /**
      * Add or modify data submitted to the server upon an Ajax request.
      */
@@ -2344,7 +2931,19 @@ interface AjaxSettings extends JQueryAjaxSettings {
     /**
      * Data property or manipulation method for table data.
      */
-    dataSrc?: string | ((data: any) => any[]);
+    dataSrc?: AjaxDataSrc | {
+        /** Mapping for `data` property */
+        data: AjaxDataSrc;
+
+        /** Mapping for `draw` property */
+        draw: AjaxDataSrc;
+
+        /** Mapping for `recordsTotal` property */
+        recordsTotal: AjaxDataSrc;
+
+        /** Mapping for `recordsFiltered` property */
+        recordsFiltered: AjaxDataSrc;
+    };
 }
 
 interface FunctionColumnData {
@@ -2368,7 +2967,7 @@ interface ObjectColumnRender {
     sort?: string | number | FunctionColumnRender;
 }
 
-interface CellMetaSettings {
+export interface CellMetaSettings {
     row: number;
     col: number;
     settings: InternalSettings;
@@ -2376,7 +2975,7 @@ interface CellMetaSettings {
 
 export interface DataTablesStaticExt {
     builder: string;
-    buttons: {[key: string]: object};
+    buttons: DataTablesStaticExtButtons;
     classes: ExtClassesSettings;
     errMode: string;
     feature: any[];
@@ -2396,6 +2995,10 @@ export interface DataTablesStaticExt {
     type: ExtTypeSettings;
 }
 
+export interface DataTablesStaticExtButtons {
+    // Intentionally empty, completed in Buttons extension
+}
+
 /**
  * Classes used by DataTables. Used for styling integration. Note
  * that these all use legacy Hungarian notation.
@@ -2415,7 +3018,7 @@ export interface DataTablesStaticExt {
 
     /**
      * Default Value:
-     * paginate_button
+     * dt-paging-button
      */
     sPageButton?: string;
 
@@ -2445,43 +3048,43 @@ export interface DataTablesStaticExt {
 
     /**
      * Default Value:
-     * dataTables_empty
+     * dt-empty
      */
     sRowEmpty?: string;
 
     /**
      * Default Value:
-     * dataTables_wrapper
+     * dt-container
      */
     sWrapper?: string;
 
     /**
      * Default Value:
-     * dataTables_filter
+     * dt-search
      */
     sFilter?: string;
 
     /**
      * Default Value:
-     * dataTables_info
+     * dt-info
      */
     sInfo?: string;
 
     /**
      * Default Value:
-     * dataTables_paginate paging_
+     * dt-paging paging_
      */
     sPaging?: string;
 
     /**
      * Default Value:
-     * dataTables_length
+     * dt-length
      */
     sLength?: string;
 
     /**
      * Default Value:
-     * dataTables_processing
+     * dt-processing
      */
     sProcessing?: string;
 
@@ -2538,31 +3141,31 @@ export interface DataTablesStaticExt {
 
     /**
      * Default Value:
-     * dataTables_scrollHead
+     * dt-scroll-head
      */
     sScrollHead?: string;
 
     /**
      * Default Value:
-     * dataTables_scrollHeadInner
+     * dt-scroll-headInner
      */
     sScrollHeadInner?: string;
 
     /**
      * Default Value:
-     * dataTables_scrollBody
+     * dt-scroll-body
      */
     sScrollBody?: string;
 
     /**
      * Default Value:
-     * dataTables_scrollFoot
+     * dt-scroll-foot
      */
     sScrollFoot?: string;
 
     /**
      * Default Value:
-     * dataTables_scrollFootInner
+     * dt-scroll-footInner
      */
     sScrollFootInner?: string;