DefinitelyTyped/types/datatables.net-fixedheader/index.d.ts
Kiarash df39576b74 Add support for static methods and defaults overwrite for datatables.net (#20685)
* Add static methods and default overwrites for datatables.net

* Add support for $("selector").dataTable()
* Add support for $.fn.dataTable.XXX and $.fn.dataTable.util.XXX
* Add support for overwriting datatables.net defaults, see test

* Remove fixed comments

* Great improvement for datatable.net-buttons

* Add all supported plugins for buttons
* Better integration in datatables.net d.ts

* Fix Api datatables.net

* Add support for datatables.net-buttons Api calls

Support for button api

* Add support for datatables-fixedheader Api

* Support for fixedHeader Api calls
* Add static functions
* Updated test

* TSLint all files

* TSLint datatables.net, datatables.net-buttoms index.d.ts
* Fix travis errors

* TSLint Tests

* Fix Travis Errors

* Fix: Add TypeScript Version

* Fix: Set TypeScript Version to 4

* Fix: Test error
2017-10-24 07:37:30 -07:00

84 lines
2.0 KiB
TypeScript

// Type definitions for datatables.net-fixedheader 3.1
// Project: https://datatables.net/extensions/fixedheader/
// Definitions by: Jared Szechy <https://github.com/szechyjs>, Kiarash Ghiaseddin <https://github.com/Silver-Connection>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.4
/// <reference types="jquery" />
/// <reference types="datatables.net"/>
declare namespace DataTables {
interface Settings {
/*
* FixedHeader extension options
*/
fixedHeader?: boolean | FixedHeaderSettings;
}
interface StaticFunctions {
FixedHeader: FixedHeaderStaticFunctions;
}
interface FixedHeaderStaticFunctions {
new (dt: Api, settings: boolean | FixedHeaderSettings): undefined;
version: string;
defaults: FixedHeaderSettings;
}
interface Api {
fixedHeader: FixedHeaderApi;
}
interface FixedHeaderApi {
/**
* Recalculate the position of the DataTable on the page and adjust the fixed element as appropriate.
*/
adjust(): Api;
/**
* Disable the fixed elements
*/
disable(): Api;
/**
* Enable / disable the fixed elements
*/
enable(enable: boolean): Api;
/**
* Get the fixed footer's offset.
*/
footerOffset(offset: number): Api;
/**
* Get the fixed header's offset.
*/
headerOffset(offset: number): Api;
}
/*
* FixedHeader extension options
*/
interface FixedHeaderSettings {
/*
* Enable / disable fixed footer
*/
footer?: boolean;
/*
* Offset the table's fixed footer
*/
footerOffset?: number;
/*
* Enable / disable fixed header
*/
header?: boolean;
/*
* Offset the table's fixed header
*/
headerOffset?: number;
}
}