mirror of
https://github.com/zhigang1992/DefinitelyTyped.git
synced 2026-06-05 06:40:35 +08:00
create old jquery.dataTables definition backup
This commit is contained in:
vvakame
479
jquery.dataTables/jquery.dataTables-1.9.4.d.ts
vendored
Executable file
479
jquery.dataTables/jquery.dataTables-1.9.4.d.ts
vendored
Executable file
@@ -0,0 +1,479 @@
|
||||
// Type definitions for JQuery DataTables 1.9.4
|
||||
// Project: http://www.datatables.net
|
||||
// Definitions by: Armin Sander <https://github.com/pragmatrix/>
|
||||
// Definitions: https://github.com/borisyankov/DefinitelyTyped
|
||||
|
||||
// missing:
|
||||
// - Static methods that are defined in JQueryStatic.fn are not typed.
|
||||
// - Plugin and extension definitions are not typed.
|
||||
|
||||
interface JQuery
|
||||
{
|
||||
dataTable(param? :DataTables.Options) : DataTables.DataTable;
|
||||
}
|
||||
|
||||
declare module DataTables
|
||||
{
|
||||
export interface DataTable
|
||||
{
|
||||
/// Perform a jQuery selector action on the table's TR elements (from the tbody) and return the resulting jQuery object.
|
||||
$(selector:string, opts?:RowParams): JQuery;
|
||||
$(selector:Node[], opts?:RowParams): JQuery;
|
||||
$(selector:JQuery, opts?:RowParams): JQuery;
|
||||
|
||||
/// Almost identical to $ in operation, but in this case returns the data for the matched rows.
|
||||
_(selector:string, opts?:RowParams): any[];
|
||||
_(selector:Node[], opts?:RowParams): any[];
|
||||
_(selector:JQuery, opts?:RowParams): any[];
|
||||
|
||||
/// Add a single new row or multiple rows of data to the table.
|
||||
fnAddData(data:any, redraw?:boolean) : number[];
|
||||
|
||||
/// This function will make DataTables recalculate the column sizes.
|
||||
fnAdjustColumnSizing(redraw? : boolean) : void;
|
||||
|
||||
/// Quickly and simply clear a table
|
||||
fnClearTable(redraw? : boolean) : void;
|
||||
|
||||
/// The exact opposite of 'opening' a row, this function will close any rows which are currently 'open'.
|
||||
fnClose(node: Node) : number;
|
||||
|
||||
/// Remove a row for the table
|
||||
fnDeleteRow(index: number, callback?: () => void, redraw?: boolean) : any[];
|
||||
fnDeleteRow(tr: Node, callback?: () => void, redraw?: boolean) : any[];
|
||||
|
||||
/// Restore the table to it's original state in the DOM by removing all of DataTables enhancements,
|
||||
/// alterations to the DOM structure of the table and event listeners.
|
||||
fnDestroy(remove?: boolean) : void;
|
||||
|
||||
/// Redraw the table
|
||||
fnDraw(complete? : boolean) : void;
|
||||
|
||||
/// Filter the input based on data
|
||||
fnFilter(input: string, column? : number, regex?: boolean, smart? : boolean, showGlobal?: boolean, caseInsensitive? : boolean) : void;
|
||||
|
||||
/// Get the data for the whole table, an individual row or an individual cell based on the provided parameters.
|
||||
fnGetData(row?: Node, col? : number) : any;
|
||||
fnGetData(row?: number, col? : number) : any;
|
||||
|
||||
/// Get an array of the TR nodes that are used in the table's body.
|
||||
fnGetNodes(row? : number) : any; // Node[] | Node
|
||||
|
||||
/// Get the array indexes of a particular cell from it's DOM element and column index including hidden columns
|
||||
fnGetPosition(node: Node) : any; // number | number[]
|
||||
|
||||
/// Check to see if a row is 'open' or not.
|
||||
fnIsOpen(tr: Node) : boolean;
|
||||
|
||||
/// This function will place a new row directly after a row which is currently on display on the page,
|
||||
/// with the HTML contents that is passed into the function.
|
||||
fnOpen(node: Node, html: string, clazz: string) : Node;
|
||||
fnOpen(node: Node, html: Node, clazz: string) : Node;
|
||||
fnOpen(node: Node, html: JQuery, clazz: string) : Node;
|
||||
|
||||
/// Change the pagination - provides the internal logic for pagination in a simple API function.
|
||||
fnPageChange(action: string, redraw?: boolean) : void;
|
||||
fnPageChange(page: number, redraw?: boolean) : void;
|
||||
|
||||
/// Show a particular column
|
||||
fnSetColumnVis(column: number, show: boolean, redraw?: boolean) : void;
|
||||
|
||||
/// Get the settings for a particular table for external manipulation
|
||||
fnSettings() : Settings;
|
||||
|
||||
/// Sort the table by a particular column
|
||||
fnSort(col: number) : void;
|
||||
fnSort(col: any[][]) : void;
|
||||
|
||||
/// Attach a sort listener to an element for a given column
|
||||
fnSortListener(node: Node, column: number, callback? : () => void): void;
|
||||
|
||||
/// Update a table cell or row - this method will accept either a single value to update the cell with,
|
||||
/// an array of values with one element for each column or an object in the same format as the original data source.
|
||||
fnUpdate(data: any, row: Node, column?:number, redraw?: boolean, action? : boolean) : number;
|
||||
fnUpdate(data: any, dataIndex: number, column?:number, redraw?: boolean, action? : boolean) : number;
|
||||
|
||||
/// Provide a common method for plug-ins to check the version of DataTables being used,
|
||||
/// in order to ensure compatibility.
|
||||
fnVersionCheck(version: string) : boolean;
|
||||
}
|
||||
|
||||
export interface Static
|
||||
{
|
||||
/// Provide a common method for plug-ins to check the version of DataTables being used,
|
||||
/// in order to ensure compatibility.
|
||||
fnVersionCheck(version: string) : boolean;
|
||||
|
||||
/// Check if a TABLE node is a DataTable table already or not.
|
||||
fnIsDataTable(table: Node) : boolean;
|
||||
|
||||
/// Get all DataTable tables that have been initialised.
|
||||
fnTables(visible? : boolean) : Node[];
|
||||
}
|
||||
|
||||
export interface RowParams
|
||||
{
|
||||
/// Select TR elements that meet the current filter criterion ("applied") or all TR elements (i.e. no filter).
|
||||
filter?: string;
|
||||
|
||||
/// Order of the TR elements in the processed array.
|
||||
/// Can be either 'current', whereby the current sorting of the table is used, or
|
||||
/// 'original' whereby the original order the data was read into the table is used.
|
||||
order?: string;
|
||||
|
||||
/// Limit the selection to the currently displayed page
|
||||
/// ("current") or not ("all"). If 'current' is given, then order is assumed to be
|
||||
/// 'current' and filter is 'applied', regardless of what they might be given as.
|
||||
page?: string;
|
||||
}
|
||||
|
||||
export interface Options
|
||||
{
|
||||
aaData?: any[];
|
||||
aaSorting?: any[];
|
||||
aaSortingFixed?: any[];
|
||||
ajax?: any;
|
||||
aLengthMenu?: any[];
|
||||
aoColumns?: ColumnOptions[];
|
||||
aoColumnDefs?: ColumnDef[];
|
||||
aoSearchCols?: any[];
|
||||
asStripClasses?: string[];
|
||||
bAutoWidth?: boolean;
|
||||
bDeferRender?: boolean;
|
||||
bDestroy?: boolean;
|
||||
bFilter?: boolean;
|
||||
bInfo?: boolean;
|
||||
bJQueryUI?: boolean;
|
||||
bLengthChange?: boolean;
|
||||
bPaginate?: boolean;
|
||||
bProcessing?: boolean;
|
||||
bRetrieve?: boolean;
|
||||
bScrollAutoCss?: boolean;
|
||||
bScrollCollapse?: boolean;
|
||||
bScrollInfinite?: boolean;
|
||||
bServerSide?: boolean;
|
||||
bSort?: boolean;
|
||||
bSortCellsTop?: boolean;
|
||||
bSortClasses?: boolean;
|
||||
bStateSave?: boolean;
|
||||
fnCookieCallback?: CookieCallback;
|
||||
fnCreatedRow?: RowCreatedCallback;
|
||||
fnDrawCallback?: DrawCallback;
|
||||
fnFooterCallback?: FooterCallback;
|
||||
fnFormatNumber?: FormatNumber;
|
||||
fnHeaderCallback?: HeaderCallback;
|
||||
fnInfoCallback?: InfoCallback;
|
||||
fnInitComplete?: InitComplete;
|
||||
fnPreDrawCallback?: PreDrawCallback;
|
||||
fnRowCallback?: RowCallback;
|
||||
|
||||
fnStateLoadCallback?: StateLoadCallback;
|
||||
fnStateLoadParams?: StateLoadParams;
|
||||
fnStateLoaded?: StateLoaded;
|
||||
fnStateSaveCallback?: StateSaveCallback;
|
||||
fnStateSaveParams?: StateSaveParams;
|
||||
iCookieDuration?: number;
|
||||
iDeferLoading?: any;
|
||||
iDisplayLength?: number;
|
||||
iDisplayStart?: number;
|
||||
iScrollLoadGap?: number;
|
||||
iTabIndex?: number;
|
||||
oLanguage?: LanguageOptions;
|
||||
oSearch?: any;
|
||||
sAjaxDataProp?: string;
|
||||
sAjaxSource?: string;
|
||||
sCookiePrefix?: string;
|
||||
sDom?: string;
|
||||
sPaginationType?: string;
|
||||
sScrollX?: string;
|
||||
sScrollXInner?: string;
|
||||
sScrollY?: string;
|
||||
sServerMethod? : string;
|
||||
}
|
||||
|
||||
export interface LanguageOptions
|
||||
{
|
||||
oAria? : AriaOptions;
|
||||
oPaginate? : PaginateOptions;
|
||||
sEmptyTable?: string;
|
||||
sInfo?: string;
|
||||
sInfoEmpty?: string;
|
||||
sInfoFiltered?: string;
|
||||
sInfoPostFix?: string;
|
||||
sInfoThousands?: string;
|
||||
sLengthMenu?: string;
|
||||
sLoadingRecords?: string;
|
||||
sProcessing?: string;
|
||||
sSearch?: string;
|
||||
sUrl?: string;
|
||||
sZeroRecords?: string;
|
||||
}
|
||||
|
||||
export interface AriaOptions
|
||||
{
|
||||
sSortAscending?: string;
|
||||
sSortDescending?: string;
|
||||
}
|
||||
|
||||
export interface PaginateOptions
|
||||
{
|
||||
sFirst?: string;
|
||||
sLast?: string;
|
||||
sNext?: string;
|
||||
sPrevious?: string;
|
||||
}
|
||||
|
||||
export interface ColumnOptions
|
||||
{
|
||||
aDataSort?: number[];
|
||||
asSorting?: string[];
|
||||
bSearchable? : boolean;
|
||||
bSortable? : boolean;
|
||||
bVisible? : boolean;
|
||||
_bAutoType? : boolean;
|
||||
fnCreatedCell?: CreatedCell;
|
||||
iDataSort?: number;
|
||||
mData?: any;
|
||||
mRender?: any;
|
||||
sCellType?: string;
|
||||
sClass?: string;
|
||||
sContentPadding?: string;
|
||||
sDefaultContent?: string;
|
||||
sName?: string;
|
||||
sSortDataType?: string;
|
||||
sSortingClass?: string;
|
||||
sTitle?: string;
|
||||
sType?: string;
|
||||
sWidth?: string;
|
||||
}
|
||||
|
||||
export interface ColumnDef extends ColumnOptions
|
||||
{
|
||||
aTargets: any[];
|
||||
}
|
||||
|
||||
export interface Settings
|
||||
{
|
||||
oFeatures : Features;
|
||||
oScroll: ScrollingSettings;
|
||||
oLanguage : { fnInfoCallback : InfoCallback; };
|
||||
oBrowser : { bScrollOversize : boolean; };
|
||||
aanFeatures: Node[][];
|
||||
aoData: Row[];
|
||||
aiDisplay: number[];
|
||||
aiDisplayMaster: number[];
|
||||
aoColumns: Column[];
|
||||
aoHeader: any[];
|
||||
aoFooter: any[];
|
||||
asDataSearch: string[];
|
||||
oPreviousSearch: any;
|
||||
aoPreSearchCols: any[];
|
||||
aaSorting: any[][];
|
||||
aaSortingFixed: any[][];
|
||||
asStripeClasses: string[];
|
||||
asDestroyStripes: string[];
|
||||
sDestroyWidth: number;
|
||||
aoRowCallback: RowCallback[];
|
||||
aoHeaderCallback: HeaderCallback[];
|
||||
aoFooterCallback: FooterCallback[];
|
||||
aoDrawCallback: DrawCallback[];
|
||||
aoRowCreatedCallback: RowCreatedCallback[];
|
||||
aoPreDrawCallback: PreDrawCallback[];
|
||||
aoInitComplete: InitComplete[];
|
||||
aoStateSaveParams: StateSaveParams[];
|
||||
aoStateLoadParams: StateLoadParams[];
|
||||
aoStateLoaded: StateLoaded[];
|
||||
sTableId: string;
|
||||
nTable: Node;
|
||||
nTHead: Node;
|
||||
nTFoot: Node;
|
||||
nTBody: Node;
|
||||
nTableWrapper: Node;
|
||||
bDeferLoading: boolean;
|
||||
bInitialized: boolean;
|
||||
aoOpenRows: any[];
|
||||
sDom: string;
|
||||
sPaginationType: string;
|
||||
iCookieDuration: number;
|
||||
sCookiePrefix: string;
|
||||
fnCookieCallback: CookieCallback;
|
||||
aoStateSave: StateSaveCallback[];
|
||||
aoStateLoad: StateLoadCallback[];
|
||||
oLoadedState: any;
|
||||
sAjaxSource: string;
|
||||
sAjaxDataProp: string;
|
||||
bAjaxDataGet: boolean;
|
||||
jqXHR: any;
|
||||
fnServerData: any;
|
||||
aoServerParams: any[];
|
||||
sServerMethod: string;
|
||||
fnFormatNumber: FormatNumber;
|
||||
aLengthMenu: any[];
|
||||
iDraw: number;
|
||||
bDrawing: boolean;
|
||||
iDrawError: number;
|
||||
_iDisplayLength: number;
|
||||
_iDisplayStart: number;
|
||||
_iDisplayEnd: number;
|
||||
_iRecordsTotal: number;
|
||||
_iRecordsDisplay: number;
|
||||
bJUI: boolean;
|
||||
oClasses: any;
|
||||
bFiltered: boolean;
|
||||
bSorted: boolean;
|
||||
bSortCellsTop: boolean;
|
||||
oInit: any;
|
||||
aoDestroyCallback: any[];
|
||||
fnRecordsTotal: () => number;
|
||||
fnRecordsDisplay: () => number;
|
||||
fnDisplayEnd: () => number;
|
||||
oInstance : any;
|
||||
sInstance: string;
|
||||
iTabIndex: number;
|
||||
nScrollHead: Node;
|
||||
nScrollFoot: Node;
|
||||
}
|
||||
|
||||
export interface Features
|
||||
{
|
||||
bAutoWidth: boolean;
|
||||
bDeferRender: boolean;
|
||||
bFilter: boolean;
|
||||
bInfo: boolean;
|
||||
bLengthChange: boolean;
|
||||
bPaginate: boolean;
|
||||
bProcessing: boolean;
|
||||
bServerSide: boolean;
|
||||
bSort: boolean;
|
||||
bSortClasses: boolean;
|
||||
bStateSave: boolean;
|
||||
}
|
||||
|
||||
export interface ScrollingSettings
|
||||
{
|
||||
bAutoCss : boolean;
|
||||
bCollapse: boolean;
|
||||
bInfinite: boolean;
|
||||
iBarWidth: number;
|
||||
iLoadGap: number;
|
||||
sX: string;
|
||||
sY: string;
|
||||
}
|
||||
|
||||
export interface Row
|
||||
{
|
||||
nTr: Node;
|
||||
_aData: any;
|
||||
_aSortData: any[];
|
||||
_anHidden: Node[];
|
||||
_sRowStripe: string;
|
||||
}
|
||||
|
||||
export interface Column
|
||||
{
|
||||
aDataSort: any;
|
||||
asSorting: string[];
|
||||
bSearchable : boolean;
|
||||
bSortable : boolean;
|
||||
bVisible : boolean;
|
||||
_bAutoType : boolean;
|
||||
fnCreatedCell: CreatedCell;
|
||||
fnGetData: (data: any, specific: string) => any;
|
||||
fnSetData: (data: any, value: any) => void;
|
||||
mData: any;
|
||||
mRender: any;
|
||||
nTh: Node;
|
||||
nIf: Node;
|
||||
sClass: string;
|
||||
sContentPadding: string;
|
||||
sDefaultContent: string;
|
||||
sName: string;
|
||||
sSortDataType: string;
|
||||
sSortingClass: string;
|
||||
sSortingClassJUI: string;
|
||||
sTitle: string;
|
||||
sType: string;
|
||||
sWidth: string;
|
||||
sWidthOrig: string;
|
||||
}
|
||||
|
||||
export interface CookieCallback
|
||||
{
|
||||
(name: string, data: any, expires: string, path: string, cookie: string) : void;
|
||||
}
|
||||
|
||||
export interface RowCreatedCallback
|
||||
{
|
||||
(row: Node, data: any[], dataIndex: number) : void;
|
||||
}
|
||||
|
||||
export interface DrawCallback
|
||||
{
|
||||
(settings: Settings) : void;
|
||||
}
|
||||
|
||||
export interface FooterCallback
|
||||
{
|
||||
(foot: Element, data: any[], start:number, end:number, display: number[]) : void;
|
||||
}
|
||||
|
||||
export interface FormatNumber
|
||||
{
|
||||
(toFormat: number) : string;
|
||||
}
|
||||
|
||||
export interface HeaderCallback
|
||||
{
|
||||
(head: Element, data: any[], start:number, end:number, display: number[]) : void;
|
||||
}
|
||||
|
||||
export interface InfoCallback
|
||||
{
|
||||
(settings: Settings, start: number, end: number, max:number, total: number, pre: string) : string;
|
||||
}
|
||||
|
||||
export interface InitComplete
|
||||
{
|
||||
(settings: Settings, json: any) : void;
|
||||
}
|
||||
|
||||
export interface PreDrawCallback
|
||||
{
|
||||
(settings: Settings) : boolean;
|
||||
}
|
||||
|
||||
export interface RowCallback
|
||||
{
|
||||
(row : Settings, data: any[], displayIndex: number, displayIndexFull: number) : void;
|
||||
}
|
||||
|
||||
export interface StateLoadCallback
|
||||
{
|
||||
(settings: Settings) : any;
|
||||
}
|
||||
|
||||
export interface StateLoadParams
|
||||
{
|
||||
(settings: Settings, data: any) : void;
|
||||
}
|
||||
|
||||
export interface StateLoaded
|
||||
{
|
||||
(settings: Settings, data: any) : void;
|
||||
}
|
||||
|
||||
export interface StateSaveCallback
|
||||
{
|
||||
(settings: any, data:any) : void;
|
||||
}
|
||||
|
||||
export interface StateSaveParams
|
||||
{
|
||||
(settings: any, data:any) : void;
|
||||
}
|
||||
|
||||
export interface CreatedCell
|
||||
{
|
||||
(nTd: Node, cellData: any, rowData: any, row: number, col: number) : void;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user