| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808 |
- declare namespace _Handsontable {
- class Core {
- constructor(element: Element, options: Handsontable.DefaultSettings);
- addHook(key: string, callback: ((...restOfArg: any[]) => void) | ((...restOfArg: any[]) => void)[]): void;
- addHookOnce(key: string, callback: (() => void) | (() => void)[]): void;
- alter(action: 'insert_row' | 'insert_col' | 'remove_row' | 'remove_col', index?: number | Array<[number, number]>, amount?: number, source?: string, keepEmptyRows?: boolean): void;
- clear(): void;
- colOffset(): number;
- colToProp(col: number): string | number;
- countCols(): number;
- countEmptyCols(ending?: boolean): number;
- countEmptyRows(ending?: boolean): number;
- countRenderedCols(): number;
- countRenderedRows(): number;
- countRows(): number;
- countSourceCols(): number;
- countSourceRows(): number;
- countVisibleCols(): number;
- countVisibleRows(): number;
- deselectCell(): void;
- destroy(): void;
- destroyEditor(revertOriginal?: boolean, prepareEditorIfNeeded?: boolean, isOutClick? : boolean): void;
- emptySelectedCells(): void;
- getActiveEditor(): object;
- getCell(row: number, col: number, topmost?: boolean): Element;
- getCellEditor<T extends Handsontable._editors.Base>(row: number, col: number): T;
- getCellMeta(row: number, col: number): Handsontable.GridSettings;
- getCellMetaAtRow(row: number): Handsontable.GridSettings[];
- getCellRenderer(row: number, col: number): Handsontable.renderers.Base;
- getCellValidator(row: number, col: number): (value: any, callback: (valid: boolean) => void) => void | RegExp | undefined;
- getColHeader(col?: number): any[] | string;
- getColWidth(col: number): number;
- getCoords(elem: Element | null): object;
- getCopyableData(row: number, column: number): string;
- getCopyableText(startRow: number, startCol: number, endRow: number, endCol: number): string;
- getData(r?: number, c?: number, r2?: number, c2?: number): any[];
- getDataAtCell(row: number, col: number): any;
- getDataAtCol(col: number): any[];
- getDataAtProp(prop: string | number): any[];
- getDataAtRow(row: number): any[];
- getDataAtRowProp(row: number, prop: string): any;
- getDataType(rowFrom: number, columnFrom: number, rowTo: number, columnTo: number): string;
- getInstance(): Handsontable;
- getPlugin<T extends keyof Handsontable.PluginsCollection>(pluginName: T): Handsontable.PluginsCollection[T];
- getRowHeader(row?: number): any[] | string;
- getRowHeight(row: number): number;
- getSchema(): object;
- getSelected(): Array<[number, number, number, number]> | undefined;
- getSelectedLast(): number[] | undefined;
- getSelectedRange(): Handsontable.wot.CellRange[] | undefined;
- getSelectedRangeLast(): Handsontable.wot.CellRange | undefined;
- getSettings(): Handsontable.DefaultSettings;
- getSourceData(r?: number, c?: number, r2?: number, c2?: number): any[];
- getSourceDataArray(r?: number, c?: number, r2?: number, c2?: number): any[];
- getSourceDataAtCell(row: number, column: number): any;
- getSourceDataAtCol(column: number): any[];
- getSourceDataAtRow(row: number): any[] | object;
- getTranslatedPhrase(dictionaryKey: string, extraArguments: any): string | null;
- getValue(): any;
- hasColHeaders(): boolean;
- hasHook(key: string): boolean;
- hasRowHeaders(): boolean;
- isColumnModificationAllowed(): boolean;
- isEmptyCol(col: number): boolean;
- isEmptyRow(row: number): boolean;
- isListening(): boolean;
- listen(): void;
- loadData(data: any[]): void;
- populateFromArray(row: number, col: number, input: any[], endRow?: number, endCol?: number, source?: string, method?: string, direction?: string, deltas?: any[]): any;
- propToCol(prop: string | number): number;
- removeCellMeta(row: number, col: number, key: string): void;
- removeHook(key: string, callback: (() => void) | (() => void)[]): void;
- render(): void;
- rowOffset(): number;
- runHooks(key: string, p1?: any, p2?: any, p3?: any, p4?: any, p5?: any, p6?: any): any;
- scrollViewportTo(row?: number, column?: number, snapToBottom?: boolean, snapToRight?: boolean): boolean;
- selectAll(): void;
- selectCell(row: number, col: number, endRow?: number, endCol?: number, scrollToCell?: boolean, changeListener?: boolean): boolean;
- selectCellByProp(row: number, prop: string, endRow?: number, endProp?: string, scrollToCell?: boolean): boolean;
- selectCells(coords: Array<[number, number | string, number, number | string]> | Array<Handsontable.wot.CellRange>, scrollToCell?: boolean, changeListener?: boolean): boolean;
- selectColumns(startColumn: number | string, endColumn?: number | string): boolean;
- selectRows(startRow: number, endRow?: number): boolean;
- setCellMeta(row: number, col: number, key: string, val: string): void;
- setCellMetaObject(row: number, col: number, prop: object): void;
- setDataAtCell(row: number, col: string | number, value: any, source?: string): void;
- setDataAtCell(changes: Array<[number, string | number, any]>, source?: string): void;
- setDataAtRowProp(row: number, prop: string, value: any, source?: string): void;
- setDataAtRowProp(changes: Array<[number, string | number, any]>, source?: string): void;
- spliceCol(col: number, index: number, amount: number, elements?: any): void;
- spliceRow(row: number, index: number, amount: number, elements?: any): void;
- toPhysicalColumn(column: number): number;
- toPhysicalRow(row: number): number;
- toVisualColumn(column: number): number;
- toVisualRow(row: number): number;
- unlisten(): void;
- updateSettings(settings: Handsontable.DefaultSettings, init?: boolean): void;
- validateCells(callback: (valid: boolean) => void): void;
- validateColumns(columns: number[], callback: (valid: boolean) => void): void;
- validateRows(rows: number[], callback: (valid: boolean) => void): void;
- isDestroyed: boolean;
- rootElement: HTMLElement;
- }
- }
- declare namespace Handsontable {
- namespace wot {
- interface CellCoords {
- col: number,
- row: number
- }
- interface CellRange {
- highlight: CellCoords;
- from: CellCoords;
- to: CellCoords;
- }
- }
- namespace cellTypes {
- interface Autocomplete {
- editor: _editors.Autocomplete;
- renderer: renderers.Autocomplete;
- validator: (value: any, callback: (valid: boolean) => void) => void;
- }
- interface Checkbox {
- editor: _editors.Checkbox;
- renderer: renderers.Checkbox;
- }
- interface Date {
- editor: _editors.Date;
- renderer: renderers.Autocomplete;
- validator: (value: any, callback: (valid: boolean) => void) => void;
- }
- interface Dropdown {
- editor: _editors.Dropdown;
- renderer: renderers.Autocomplete;
- validator: (value: any, callback: (valid: boolean) => void) => void;
- }
- interface Handsontable {
- editor: _editors.Handsontable;
- renderer: renderers.Autocomplete;
- }
- interface Numeric {
- dataType: string;
- editor: _editors.Numeric;
- renderer: renderers.Numeric;
- validator: (value: any, callback: (valid: boolean) => void) => void;
- }
- interface Password {
- copyable: boolean;
- editor: _editors.Password;
- renderer: renderers.Password;
- }
- interface Text {
- editor: _editors.Text;
- renderer: renderers.Text;
- }
- interface Time {
- editor: _editors.Text;
- renderer: renderers.Text;
- validator: (value: any, callback: (valid: boolean) => void) => void;
- }
- }
- namespace _editors {
- class Base {
- instance: _Handsontable.Core;
- row: number;
- col: number;
- prop: string | number;
- TD: HTMLElement;
- cellProperties: object;
- constructor(hotInstance: _Handsontable.Core, row: number, col: number, prop: string | number, TD: HTMLElement, cellProperties: GridSettings)
- beginEditing(initialValue?: string): void;
- cancelChanges(): void;
- checkEditorSection(): 'top-left-corner' | 'top' | 'bottom-left-corner' | 'bottom' | 'left' | '' ;
- close(): void;
- discardEditor(validationResult?: boolean): void;
- enableFullEditMode(): void;
- extend<T extends _editors.Base>(): T;
- finishEditing(restoreOriginalValue?: boolean, ctrlDown?: boolean, callback?: () => void): void;
- getValue(): any;
- init(): void;
- isInFullEditMode(): boolean;
- isOpened(): boolean;
- isWaiting(): boolean;
- open(): void;
- prepare(row: number, col: number, prop: string | number, TD: HTMLElement, originalValue: any, cellProperties: GridSettings): void;
- saveValue(val?: any, ctrlDown?: boolean): void;
- setValue(newValue?: any): void;
- lock(): void;
- unlock(): void;
- getLockState(): boolean;
- }
- class Checkbox extends Base {
- }
- class Mobile extends Base {
- hideCellPointer(): void;
- onBeforeKeyDown(event?: Event): void;
- prepareAndSave(): void;
- scrollToView(): void;
- updateEditorData(): void;
- updateEditorPosition(x?: number, y?: number): void;
- valueChanged(): boolean;
- }
- class Select extends Base {
- focus(): void;
- getEditedCell(): Element | undefined;
- prepareOptions(optionsToPrepare?: object | any[]): void;
- refreshDimensions(): void;
- refreshValue(): void;
- registerHooks(): void;
- }
- class Text extends Base {
- bindEvents(): void;
- close(tdOutside?: HTMLElement): void;
- createElements(): void;
- destroy(): void;
- focus(): void;
- hideEditableElement(): void;
- showEditableElement(): void;
- getEditedCell(): Element | undefined;
- refreshDimensions(force?: boolean): void;
- refreshValue(): void;
- TEXTAREA: HTMLInputElement;
- TEXTAREA_PARENT: HTMLElement;
- textareaStyle: CSSStyleDeclaration;
- }
- class Date extends Text {
- close(): void;
- destroyElements(): void;
- finishEditing(isCancelled?: boolean, ctrlDown?: boolean): void;
- getDatePickerConfig(): object;
- hideDatepicker(): void;
- open(event?: Event): void;
- showDatepicker(event?: Event): void;
- }
- class Handsontable extends Text {
- assignHooks(): void;
- beginEditing(initialValue?: any): void;
- close(): void;
- finishEditing(isCancelled?: boolean, ctrlDown?: boolean): void;
- focus(): void;
- open(): void;
- }
- class Numeric extends Text {
- }
- class Password extends Text {
- }
- class Autocomplete extends Handsontable {
- allowKeyEventPropagation(keyCode?: number): boolean;
- finishEditing(restoreOriginalValue?: boolean): void;
- flipDropdown(dropdownHeight?: number): void;
- flipDropdownIfNeeded(): void;
- getDropdownHeight(): number;
- highlightBestMatchingChoice(index?: number): void;
- limitDropdownIfNeeded(spaceAvailable?: number, dropdownHeight?: number): void;
- queryChoices(query?: any): void;
- sortByRelevance(value?: any, choices?: any[], caseSensitive?: boolean): any[];
- setDropdownHeight(height?: number): void;
- updateChoicesList(choices?: any[]): void;
- unflipDropdown(): void;
- updateDropdownHeight(): void;
- }
- class Dropdown extends Autocomplete {
- }
- class CommentEditor {
- editor: HTMLElement;
- editorStyle: CSSStyleDeclaration;
- hidden: boolean;
- setPosition(x: number, y: number): void;
- setSize(width: number, height: number): void;
- resetSize(): void;
- setReadOnlyState(state: boolean): void;
- show(): void;
- hide(): void;
- isVisible(): boolean;
- setValue(value?: string): void;
- getValue(): string;
- isFocused(): boolean;
- focus(): void;
- createEditor(): HTMLElement;
- getInputElement(): HTMLElement;
- destroy(): void;
- }
- }
- namespace plugins {
- // utils for Filters
- namespace FiltersPlugin {
- type OperationType = 'conjunction' | 'disjunction';
- type ConditionName = 'begins_with' | 'between' | 'by_value' | 'contains' | 'empty' | 'ends_with' | 'eq' | 'gt' |
- 'gte' | 'lt' | 'lte' | 'not_between' | 'not_contains' | 'not_empty' | 'neq';
- interface ConditionId {
- args: any[];
- name?: ConditionName
- command?: {
- key: ConditionName
- }
- }
- interface Condition {
- name: ConditionName,
- args: any[];
- func: (dataRow: CellValue, values: any[]) => boolean
- }
- interface CellLikeData {
- meta: {
- row: number,
- col: number,
- visualCol: number,
- visualRow: number,
- type: string,
- instance: _Handsontable.Core,
- dateFormat?: string
- },
- value: string
- }
- interface BaseComponent {
- elements: any[];
- hidden: boolean;
- destroy(): boolean;
- hide(): void;
- isHidden(): boolean;
- reset(): void;
- show(): void;
- }
- interface ActionBarComponent extends BaseComponent {
- getMenuItemDescriptor(): object;
- accept(): void;
- cancel(): void;
- }
- interface ConditionComponent extends BaseComponent {
- getInputElement(index?: number): InputUI;
- getInputElements(): InputUI[];
- getMenuItemDescriptor(): object;
- getSelectElement(): SelectUI;
- getState(): object;
- setState(value: object): void;
- updateState(stateInfo: object): void;
- }
- interface ValueComponent extends BaseComponent {
- getMenuItemDescriptor(): object;
- getMultipleSelectElement(): MultipleSelectUI;
- getState(): object;
- setState(value: object): void;
- updateState(stateInfo: object): void;
- }
- interface BaseUI {
- buildState: boolean;
- eventManager: EventManager;
- hot: _Handsontable.Core;
- options: object;
- build(): void;
- destroy(): void;
- element(): Element;
- focus(): void;
- getValue(): any;
- hide(): void;
- isBuilt(): boolean;
- reset(): void;
- setValue(value: any): any;
- show(): void;
- update(): void;
- }
- type InputUI = BaseUI
- interface MultipleSelectUI extends BaseUI {
- clearAllUI: BaseUI;
- items: any[];
- itemsBox: _Handsontable.Core;
- searchInput: InputUI;
- selectAllUI: BaseUI;
- getItems(): void;
- getValue(): any[];
- isSelectedAllValues(): boolean;
- setItems(items: any[]): void;
- }
- interface SelectUI extends BaseUI {
- menu: Menu | void;
- items: any[];
- setItems(items: any[]): void;
- openOptions(): void;
- closeOptions(): void;
- }
- interface ConditionCollection {
- conditions: object;
- orderStack: any[];
- addCondition(column: number, conditionDefinition: ConditionId, operation?: OperationType): void;
- clean(): void;
- clearConditions(column: number): void;
- destroy(): void;
- exportAllConditions(): ConditionId[];
- getConditions(column: number): Condition[];
- hasConditions(column: number, name: string): boolean;
- isEmpty(): boolean;
- isMatch(value: CellLikeData, column: number): boolean;
- isMatchInConditions(conditions: Condition[], value: CellLikeData, operationType?: OperationType): boolean;
- importAllConditions(conditions: ConditionId[]): void;
- removeConditions(column: number): void;
- }
- interface ConditionUpdateObserver {
- changes: number[];
- columnDataFactory: (column: number) => object[];
- conditionCollection: ConditionCollection;
- grouping: boolean;
- latestEditedColumnPosition: number;
- latestOrderStack: number[];
- destroy(): void;
- flush(): void;
- groupChanges(): void;
- updateStatesAtColumn(column: number, conditionArgsChange: object): void;
- }
- }
- interface BindStrategy {
- klass: () => void;
- strategy: string | void;
- clearMap(): void;
- createMap(length: number): void;
- createRow(params: any): void;
- destroy(): void;
- removeRow(params: any): void;
- setStrategy(name: string): void;
- translate(params: any): void;
- }
- interface CommandExecutor {
- hot: _Handsontable.Core;
- commands: object;
- commonCallback: (() => void) | void;
- registerCommand(name: string, commandDescriptor: object): void;
- setCommonCallback(callback: () => void): void;
- execute(commandName: string, ...params: any[]): void;
- }
- interface Cursor {
- cellHeight: number;
- cellWidth: number;
- left: number;
- leftRelative: number;
- scrollLeft: number;
- scrollTop: number;
- top: number;
- topRelative: number;
- type: string;
- fitsAbove(element: HTMLElement): boolean;
- fitsBelow(element: HTMLElement, viewportHeight?: number): boolean;
- fitsOnLeft(element: HTMLElement): boolean;
- fitsOnRight(element: HTMLElement, viewportHeight?: number): boolean;
- getSourceType(object: any): string;
- }
- interface Endpoints {
- plugin: plugins.ColumnSummary;
- hot: _Handsontable.Core;
- endpoints: any[];
- settings: object | (() => void);
- settingsType: string;
- currentEndpoint: object | void;
- assignSetting(settings: object, endpoint: object, name: string, defaultValue: any): void;
- getAllEndpoints(): any[];
- getEndpoint(index: number): object;
- parseSettings(settings: any[]): void;
- refreshAllEndpoints(init: boolean): void;
- refreshChangedEndpoints(changes: any[]): void;
- refreshEndpoint(endpoint: object): void;
- resetAllEndpoints(endpoints: any[], useOffset?: boolean): void;
- resetEndpointValue(endpoint: object, useOffset?: boolean): void;
- setEndpointValue(endpoint: object, source: string, render?: boolean): void;
- }
- interface EventManager {
- context?: object;
- addEventListener(element: Element, eventName: string, callback: (event: Event) => void): () => void;
- removeEventListener(element: Element, eventName: string, callback: (event: Event) => void): void;
- clearEvents(): void;
- clear(): void;
- destroy(): void;
- fireEvent(element: Element, eventName: string): void;
- extendEvent(context: object, event: Event): any;
- }
- interface EditorManagerInstance {
- lockEditor(): void;
- unlockEditor(): void;
- getLockState(): boolean;
- }
- interface EditorManager {
- getInstance(hotInstance: _Handsontable.Core, hotSettings?: Handsontable.DefaultSettings, selection?: any, datamap?: any): EditorManagerInstance
- }
- interface GhostTable {
- columns: number[];
- container: HTMLElement | null;
- hot: _Handsontable.Core;
- injected: boolean;
- rows: object[];
- samples: object | null;
- settings: object;
- addRow(row: number, samples: object): void;
- addColumn(column: number, samples: object): void;
- addColumnHeadersRow(samples: object): void;
- clean(): void;
- createCol(column: number): DocumentFragment;
- createColElement(column: number): HTMLElement;
- createColGroupsCol(): DocumentFragment;
- createColumnHeadersRow(): DocumentFragment;
- createContainer(className?: string): object;
- createRow(row: number): DocumentFragment;
- createTable(className?: string): object;
- getHeights(callback: (row: number, height: number) => void): void;
- getWidths(callback: (row: number, height: number) => void): void;
- getSettings(): object | void;
- getSetting(name: string): boolean | void;
- injectTable(parent?: HTMLElement | void): void;
- isHorizontal(): boolean;
- isVertical(): boolean;
- removeTable(): void;
- setSettings(settings: DefaultSettings): void;
- setSetting(name: string, value: any): void;
- }
- interface ItemsFactory {
- defaultOrderPattern: any[] | void;
- hot: _Handsontable.Core;
- predefinedItems: object;
- getItems(pattern?: any[] | object | boolean): any[];
- setPredefinedItems(predefinedItems: any[]): void;
- }
- interface Menu {
- container: HTMLElement;
- eventManager: EventManager;
- hot: _Handsontable.Core;
- hotMenu: _Handsontable.Core;
- hotSubMenus: object;
- keyEvent: boolean;
- menuItems: any[] | null;
- offset: object;
- options: object;
- origOutsideClickDeselects: boolean | (() => void);
- parentMenu: Menu | null;
- close(closeParent?: boolean): void;
- closeSubMenu(row: number): void;
- closeAllSubMenus(): void;
- destroy(): void;
- executeCommand(event: Event): void;
- isOpened(): boolean;
- isSubMenu(): boolean;
- open(): void;
- openSubMenu(row: number): Menu | boolean;
- setMenuItems(menuItems: any[]): void;
- setOffset(area: string, offset?: number): void;
- selectLastCell(): void;
- selectFirstCell(): void;
- selectPrevCell(row: number, col: number): void;
- selectNextCell(row: number, col: number): void;
- setPosition(coords: Event | object): void;
- setPositionAboveCursor(cursor: Cursor): void;
- setPositionBelowCursor(cursor: Cursor): void;
- setPositionOnLeftOfCursor(cursor: Cursor): void;
- setPositionOnRightOfCursor(cursor: Cursor): void;
- }
- interface SamplesGenerator {
- allowDuplicates: boolean | null;
- customSampleCount: boolean | null;
- dataFactory: () => void;
- samples: object | null;
- generateColumnSamples(colRange: object, rowRange: object): object;
- generateRowSamples(rowRange: object | number, colRange: object): object;
- generateSamples(type: string, range: object, specifierRange: object | number): object;
- generateSample(type: string, range: object, specifierValue: number): object
- getSampleCount(): number;
- setAllowDuplicates(allowDuplicates: boolean): void;
- setSampleCount(sampleCount: number): void;
- }
- class Base {
- pluginName: string;
- pluginsInitializedCallback: any[];
- isPluginsReady: boolean;
- enabled: boolean;
- initialized: boolean;
- constructor(hotInstance?: _Handsontable.Core);
- addHook(name: string, callback: (...restOfArg: any[]) => void): void;
- callOnPluginsReady(callback: () => void): void;
- clearHooks(): void;
- destroy(): void;
- disablePlugin(): void;
- enablePlugin(): void;
- init(): void;
- removeHook(name: string): void;
- }
- interface AutoColumnSize extends Base {
- firstCalculation: boolean;
- ghostTable: GhostTable;
- inProgress: boolean;
- samplesGenerator: SamplesGenerator;
- widths: any[];
- calculateAllColumnsWidth(rowRange?: number | object): void;
- calculateColumnsWidth(colRange?: number | object, rowRange?: number | object, force?: boolean): void;
- clearCache(columns?: any[]): void;
- findColumnsWhereHeaderWasChanged(): any[];
- getColumnWidth(col: number, defaultWidth?: number, keepMinimum?: boolean): number;
- getFirstVisibleColumn(): number;
- getLastVisibleColumn(): number;
- getSyncCalculationLimit(): number;
- isNeedRecalculate(): boolean;
- recalculateAllColumnsWidth(): void;
- }
- interface AutoRowSize extends Base {
- firstCalculation: boolean;
- heights: any[];
- ghostTable: GhostTable;
- inProgress: boolean;
- sampleGenerator: SamplesGenerator;
- calculateAllRowsHeight(colRange?: number | object): void;
- calculateRowsHeight(rowRange?: number | object, colRange?: number | object, force?: boolean): void;
- clearCache(): void;
- clearCacheByRange(range: number | object): void;
- findColumnsWhereHeaderWasChanged(): any[];
- getColumnHeaderHeight(): number | void;
- getFirstVisibleRow(): number;
- getLastVisibleRow(): number;
- getRowHeight(col: number, defaultHeight?: number): number;
- getSyncCalculationLimit(): number;
- isNeedRecalculate(): boolean;
- recalculateAllRowsHeight(): void;
- }
- interface Autofill extends Base {
- addingStarted: boolean;
- autoInsertRow: boolean;
- directions: string[];
- eventManager: EventManager;
- handleDraggedCells: number;
- mouseDownOnCellCorner: boolean;
- mouseDragOutside: boolean;
- }
- interface BindRowsWithHeaders extends Base {
- bindStrategy: BindStrategy;
- removeRows: any[];
- }
- interface CollapsibleColumns extends Base {
- buttonEnabledList: object;
- collapsedSections: object;
- columnHeaderLevelCount: number;
- eventManager: EventManager;
- hiddenColumnsPlugin: object;
- nestedHeadersPlugin: object;
- settings: boolean | any[];
- checkDependencies(): void;
- collapseAll(): void;
- collapseSection(coords: object): void;
- expandAll(): void;
- expandSection(coords: object): void;
- generateIndicator(col: number, TH: HTMLElement): HTMLElement;
- markSectionAs(state: string, row: number, column: number, recursive: boolean): void;
- meetsDependencies(): boolean;
- parseSettings(): void;
- toggleAllCollapsibleSections(action: string): void;
- toggleCollapsibleSection(coords: object, action: string): void;
- }
- interface ColumnSorting extends Base {
- clearSort(): void;
- destroy(): void;
- getSortConfig(column: number): void | columnSorting.Config
- getSortConfig(): Array<columnSorting.Config>
- isSorted(): boolean;
- setSortConfig(sortConfig?: columnSorting.Config | Array<columnSorting.Config>): void;
- sort(sortConfig?: columnSorting.Config): void;
- }
- interface ColumnSummary extends Base {
- endpoints: Endpoints | void;
- calculate(endpoint: Endpoints): void;
- calculateAverage(endpoint: Endpoints): number;
- calculateMinMax(endpoint: Endpoints, type: string): number;
- calculateSum(endpoint: Endpoints): void;
- countEmpty(rowRange: any[], col: number): number;
- countEntries(endpoint: Endpoints): number;
- getCellValue(row: number, col: number): string;
- getPartialMinMax(rowRange: any[], col: number, type: string): number;
- getPartialSum(rowRange: any[], col: number): number;
- }
- type CommentsRangeObject = {
- from: wot.CellCoords,
- to?: wot.CellCoords
- }
- interface Comments extends Base {
- contextMenuEvent: boolean;
- displayDelay: number;
- editor: _editors.CommentEditor;
- eventManager: EventManager;
- mouseDown: boolean;
- range: CommentsRangeObject;
- timer: any;
- clearRange(): void;
- getComment(): string;
- getCommentMeta(row: number, column: number, property: string): any;
- hide(): void;
- refreshEditor(force?: boolean): void;
- removeComment(forceRender?: boolean): void;
- removeCommentAtCell(row: number, col: number, forceRender?: boolean): void;
- setComment(value: string): void;
- setCommentAtCell(row: number, col: number, value: string): void;
- setRange(range: CommentsRangeObject): void;
- show(): boolean;
- showAtCell(row: number, col: number): boolean;
- targetIsCellWithComment(event: Event): boolean;
- targetIsCommentTextArea(event: Event): boolean;
- updateCommentMeta(row: number, column: number, metaObject: object): void;
- }
- interface ContextMenu extends Base {
- eventManager: EventManager;
- commandExecutor: CommandExecutor;
- itemsFactory: ItemsFactory | void;
- menu: Menu | void;
- close(): void;
- executeCommand(commandName: string, ...params: any[]): void;
- open(event: Event): void;
- }
- interface FocusableWrapper {
- mainElement: HTMLElement;
- eventManager: EventManager;
- listenersCount: WeakSet<HTMLElement>;
- useSecondaryElement(): void;
- setFocusableElement(element: HTMLElement): void;
- getFocusableElement(): HTMLElement;
- focus(): void;
- }
- type PasteModeType = 'overwrite' | 'shift_down' | 'shift_right';
- type RangeType = { startRow: number, startCol: number, endRow: number, endCol: number };
- interface CopyPaste extends Base {
- eventManager: EventManager;
- columnsLimit: number;
- copyableRanges: any[];
- pasteMode: PasteModeType;
- rowsLimit: number;
- focusableElement: FocusableWrapper;
- setCopyableText(): void;
- getRangedCopyableData(ranges: RangeType[]): string;
- getRangedData(ranges: RangeType[]): any[];
- copy(triggeredByClick?: boolean): void;
- cut(triggeredByClick?: boolean): void;
- paste(triggeredByClick?: boolean): void;
- }
- interface CustomBorders extends Base {
- savedBorderSettings: any[];
- setBorders(selection: Range[] | Array<[number, number, number, number]>, borderObject: object): void;
- getBorders(selection: Range[] | Array<[number, number, number, number]>): Array<[object]>;
- clearBorders(selection: Range[] | Array<[number, number, number, number]>): void;
- }
- interface DragToScroll extends Base {
- boundaries: object | void;
- callback: (() => void) | void;
- check(x: number, y: number): void;
- setBoundaries(boundaries: object): void;
- setCallback(callback: () => void): void;
- }
- type SeparatorObject = {
- name: string;
- }
- interface DropdownMenu extends Base {
- eventManager: EventManager;
- commandExecutor: CommandExecutor;
- itemsFactory: ItemsFactory | void;
- menu: Menu | void;
- SEPARATOR: SeparatorObject
- close(): void;
- executeCommand(commandName: string, ...params: any[]): void;
- open(event: Event): void;
- }
- interface ExportFile extends Base {
- downloadFile(format: string, options: object): void;
- exportAsString(format: string, options?: object): string;
- exportAsBlob(format: string, options?: object): Blob;
- }
- interface Filters extends Base {
- actionBarComponent: FiltersPlugin.ActionBarComponent | void;
- dropdownMenuPlugin: DropdownMenu | void;
- eventManager: EventManager;
- conditionComponent: FiltersPlugin.ConditionComponent | void;
- conditionCollection: FiltersPlugin.ConditionCollection | void;
- conditionUpdateObserver: FiltersPlugin.ConditionUpdateObserver | void;
- lastSelectedColumn?: number | void;
- trimRowsPlugin: TrimRows | void;
- valueComponent: FiltersPlugin.ValueComponent | void;
- addCondition(column: number, name: string, args: any[], operationId: FiltersPlugin.OperationType): void;
- clearColumnSelection(): void;
- clearConditions(column?: number | void): void;
- getDataMapAtColumn(column: number): FiltersPlugin.CellLikeData[];
- getSelectedColumn(): number | void;
- filter(): void;
- removeConditions(column: number): void;
- }
- interface RecordTranslator {
- hot: _Handsontable.Core;
- toPhysical(row: number | object, column?: number): object | any[];
- toPhysicalColumn(column: number): number;
- toPhysicalRow(row: number): number;
- toVisual(row: number | object, column?: number): object | any[];
- toVisualColumn(column: number): number;
- toVisualRow(row: number): number;
- }
- interface DataProvider {
- changes: object;
- hot: _Handsontable.Core;
- t: RecordTranslator;
- clearChanges(): void;
- collectChanges(row: number, column: number, value: any): void;
- destroy(): void;
- getDataAtCell(row: number, column: number): any;
- getDataByRange(row1: number, column1: number, row2: number, column2: number): any[];
- getRawDataAtCell(row: number, column: number): any;
- getRawDataByRange(row1: number, column1: number, row2: number, column2: number): any[];
- getSourceDataByRange(row1: number, column1: number, row2: number, column2: number): any[];
- getSourceDataAtCell(row: number, column: number): any;
- isInDataRange(row: number, column: number): boolean;
- updateSourceData(row: number, column: number, value: any): void;
- }
- interface AlterManager {
- sheet: Sheet;
- hot: _Handsontable.Core;
- dataProvider: DataProvider;
- matrix: Matrix;
- prepareAlter(action: string, args: any): void;
- triggerAlter(action: string, args: any): void;
- destroy(): void;
- }
- interface Matrix {
- t: RecordTranslator;
- data: any[];
- cellReferences: any[];
- getCellAt(row: number, column: number): CellValue | void;
- getOutOfDateCells(): any[];
- add(cellValue: CellValue | object): void;
- remove(cellValue: CellValue | object | any[]): void;
- getDependencies(cellCoord: object): void;
- registerCellRef(cellReference: CellReference | object): void;
- removeCellRefsAtRange(start: object, end: object): any[];
- reset(): void;
- }
- interface BaseCell {
- columnAbsolute: boolean;
- columnOffset: number;
- rowAbsolute: boolean;
- rowOffset: number;
- isEqual(cell: BaseCell): boolean;
- toString(): string;
- translateTo(rowOffset: number, columnOffset: number): void;
- }
- type CellReference = BaseCell
- interface CellValue extends BaseCell {
- error: string | void;
- precedents: any[];
- state: string;
- value: any;
- addPrecedent(cellReference: CellReference): void;
- clearPrecedents(): void;
- getError(): string | void;
- getPrecedents(): any[];
- getValue(): any;
- hasError(): boolean;
- hasPrecedent(cellReference: CellReference): boolean;
- hasPrecedents(): boolean;
- isState(state: number): boolean;
- removePrecedent(cellReference: CellReference): void;
- setError(error: string): void;
- setState(state: number): void;
- setValue(value: any): void;
- }
- type Parser = {};
- interface Sheet {
- alterManager: AlterManager
- dataProvider: DataProvider;
- hot: _Handsontable.Core;
- matrix: Matrix;
- parser: Parser;
- t: RecordTranslator;
- applyChanges(row: number, column: number, newValue: any): void;
- destroy(): void;
- getCellAt(row: number, column: number): CellValue | void;
- getCellDependencies(row: number, column: number): any[];
- getVariable(name: string): any;
- parseExpression(cellValue: CellValue | object, formula: string): void;
- recalculate(): void;
- recalculateFull(): void;
- recalculateOptimized(): void;
- setVariable(name: string, value: any): void;
- }
- interface Stack {
- items: any[];
- isEmpty(): boolean;
- peek(): any;
- pop(): any;
- push(items: any): void;
- size(): number;
- }
- interface UndoRedoSnapshot {
- sheet: Sheet;
- stack: Stack;
- destroy(): void;
- restore(): void;
- save(axis: string, index: number, amount: number): void;
- }
- interface Formulas extends Base {
- dataProvider: DataProvider;
- eventManager: EventManager;
- sheet: Sheet;
- undoRedoSnapshot: UndoRedoSnapshot;
- getCellValue(row: number, column: number): any;
- getVariable(name: string): any;
- hasComputedCellValue(row: number, column: number): boolean;
- recalculate(): void;
- recalculateFull(): void;
- recalculateOptimized(): void;
- setVariable(name: string, value: any): void;
- }
- interface GanttChart extends Base {
- colorData: object;
- currentYear: number | void;
- dateCalculator: object | void;
- dataFeed: object | void;
- hotSource: _Handsontable.Core | void;
- initialSettings: object | void;
- monthHeadersArray: any[];
- monthList: any[];
- nestedHeadersPlugin: NestedHeaders | void;
- overallWeekSectionCount: number | void;
- rangeBarMeta: object | void;
- rangeBars: object;
- rangeList: object;
- settings: object;
- weekHeadersArray: any[];
- addRangeBar(row: number, startDate: Date | string, endDate: Date | string, additionalData: object): boolean | any[];
- applyRangeBarMetaCache(): void;
- cacheRangeBarMeta(row: number, col: number, key: string, value: any | any[]): void;
- checkDependencies(): void;
- getRangeBarCoordinates(row: number): object;
- getRangeBarData(row: number, column: number): object | boolean;
- renderRangeBar(row: number, startDateColumn: number, endDateColumn: number, additionalData: object): void;
- removeRangeBarByDate(row: number, startDate: Date | string): void;
- removeRangeBarByColumn(row: number, startDateColumn: number): void;
- removeAllRangeBars(): void;
- setRangeBarColors(rows: object): void;
- setYear(year: number): void;
- uniformBackgroundRenderer(instance: _Handsontable.Core, TD: HTMLElement, row: number, col: number, prop: string | number, value: string | number, cellProperties: GridSettings): void;
- unrenderRangeBar(row: number, startDateColumn: number, endDateColumn: number): void;
- updateRangeBarData(row: number, column: number, data: object): void;
- }
- interface HeaderTooltips extends Base {
- settings: boolean | object;
- parseSettings(): void;
- }
- interface HiddenColumns extends Base {
- hiddenColumns: boolean | any[];
- lastSelectedColumn: number;
- settings: object | void;
- isHidden(column: number, isLogicIndex?: boolean): boolean;
- hideColumn(column: number): void;
- hideColumns(columns: any[]): void;
- showColumn(column: number): void;
- showColumns(columns: any[]): void;
- }
- interface HiddenRows extends Base {
- hiddenRows: boolean | any[];
- lastSelectedRow: number;
- settings: object | void;
- isHidden(row: number, isLogicIndex?: boolean): boolean;
- hideRow(row: number): void;
- hideRows(rows: any[]): void;
- showRow(row: number): void;
- showRows(rows: any[]): void;
- }
- interface ManualColumnFreeze extends Base {
- frozenColumnsBasePositions: any[];
- manualColumnMovePlugin: ManualColumnMove;
- freezeColumn(column: number): void;
- unfreezeColumn(column: number): void;
- }
- interface arrayMapper {
- getValueByIndex(index: number): any;
- getIndexByValue(value: any): number;
- insertItems(index: number, amount?: number): any[];
- removeItems(index: number, amount?: number): any[];
- shiftItems(index: number, amount?: number): void;
- unshiftItems(index: number, amount?: number): void;
- }
- interface MoveColumnsMapper extends arrayMapper {
- manualColumnMove: ManualColumnMove;
- clearNull(): void;
- createMap(length?: number): void;
- destroy(): void;
- moveColumn(from: number, to: number): void;
- }
- interface MoveRowsMapper extends arrayMapper {
- manualRowMove: ManualRowMove;
- clearNull(): void;
- createMap(length?: number): void;
- destroy(): void;
- moveColumn(from: number, to: number): void;
- }
- interface MultiColumnSorting extends Base {
- clearSort(): void;
- destroy(): void;
- getSortConfig(column: number): void | columnSorting.Config
- getSortConfig(): Array<columnSorting.Config>
- isSorted(): boolean;
- setSortConfig(sortConfig?: columnSorting.Config | Array<columnSorting.Config>): void;
- sort(sortConfig?: columnSorting.Config | Array<columnSorting.Config>): void;
- }
- interface TrimRowsMapper extends arrayMapper {
- trimRows: TrimRows;
- createMap(length?: number): void;
- destroy(): void;
- }
- namespace moveUI {
- interface BaseUI {
- hot: _Handsontable.Core;
- state: number;
- appendTo(wrapper: HTMLElement): void;
- build(): void;
- destroy(): void;
- getOffset(): object;
- getPosition(): object;
- getSize(): object;
- isAppended(): boolean;
- isBuilt(): boolean;
- setOffset(top: number, left: number): void;
- setPosition(top: number, left: number): void;
- setSize(width: number, height: number): void;
- }
- type BacklightUI = BaseUI
- type GuidelineUI = BaseUI
- }
- interface MergeCells extends Base {
- mergedCellsCollection: MergeCellsPlugin.MergedCellsCollection;
- autofillCalculations: MergeCellsPlugin.AutofillCalculations;
- selectionCalculations: MergeCellsPlugin.SelectionCalculations;
- clearCollections(): void;
- mergeSelection(cellRange: wot.CellRange): void;
- merge(startRow: number, startColumn: number, endRow: number, endColumn: number): void;
- unmerge(startRow: number, startColumn: number, endRow: number, endColumn: number): void;
- }
- namespace MergeCellsPlugin {
- interface AutofillCalculations {
- plugin: MergeCells;
- mergedCellsCollection: MergeCellsPlugin.MergedCellsCollection;
- currentFillData: object;
- correctSelectionAreaSize(selectionArea: number[]): void;
- getDirection(selectionArea: number[], finalArea: number[]): string;
- snapDragArea(baseArea: number[], dragArea: number[], dragDirection: string, foundMergedCells: MergeCellsPlugin.MergedCellCoords[]): number[];
- recreateAfterDataPopulation(changes: any[]): void;
- dragAreaOverlapsCollections(baseArea: number[], fullArea: number[], direction: string): boolean;
- }
- interface SelectionCalculations {
- snapDelta(delta: object, selectionRange: wot.CellRange, mergedCell: MergeCellsPlugin.MergedCellCoords): void;
- getUpdatedSelectionRange(oldSelectionRange: wot.CellRange, delta: object): wot.CellRange;
- }
- interface MergedCellCoords {
- row: number;
- col: number;
- rowspan: number;
- colspan: number;
- removed: boolean;
- normalize(hotInstance: _Handsontable.Core): void;
- includes(row: number, column: number): boolean;
- includesHorizontally(column: number): boolean;
- includesVertically(row: number): boolean;
- shift(shiftVector: number[], indexOfChange: number): boolean;
- isFarther(mergedCell: MergeCellsPlugin.MergedCellCoords, direction: string): boolean | void;
- getLastRow(): number;
- getLastColumn(): number;
- getRange(): wot.CellRange;
- }
- interface MergedCellsCollection {
- plugin: MergeCells;
- mergedCells: MergeCellsPlugin.MergedCellCoords[];
- hot: _Handsontable.Core;
- get(row: number, column: number): MergeCellsPlugin.MergedCellCoords | boolean;
- getByRange(range: wot.CellRange | object): MergeCellsPlugin.MergedCellCoords | boolean;
- getWithinRange(range: wot.CellRange | object, countPartials: boolean): MergeCellsPlugin.MergedCellCoords[] | boolean;
- add(mergedCellInfo: object): MergeCellsPlugin.MergedCellCoords | boolean;
- remove(row: number, column: number): MergeCellsPlugin.MergedCellCoords | boolean;
- clear(): void;
- isOverlapping(mergedCell: MergeCellsPlugin.MergedCellCoords): boolean;
- isMergedParent(row: number, column: number): boolean;
- shiftCollections(direction: string, index: number, count: number): void;
- }
- }
- interface ManualColumnMove extends Base {
- backlight: moveUI.BacklightUI;
- columnsMapper: MoveColumnsMapper;
- eventManager: EventManager;
- guideline: moveUI.GuidelineUI;
- removedColumns: any[];
- moveColumn(column: number, target: number): void;
- moveColumns(columns: number[], target: number): void;
- }
- interface ManualColumnResize extends Base {
- autoresizeTimeout: (() => void) | void;
- currentCol: number | void;
- currentTH: HTMLElement | void;
- currentWidth: number | void;
- dblclick: number;
- eventManager: EventManager;
- guide: HTMLElement;
- handle: HTMLElement;
- manualColumnWidths: any[];
- newSize: number | void;
- pressed: _Handsontable.Core | void;
- selectedCols: any[];
- startOffset: number | void;
- startWidth: number | void;
- startY: number | void;
- checkIfColumnHeader(element: HTMLElement): boolean;
- clearManualSize(column: number): void;
- getTHFromTargetElement(element: HTMLElement): HTMLElement;
- hideHandleAndGuide(): void;
- loadManualColumnWidths(): void;
- refreshGuidePosition(): void;
- refreshHandlePosition(): void;
- saveManualColumnWidths(): void;
- setManualSize(column: number, width: number): number;
- setupGuidePosition(): void;
- setupHandlePosition(TH: HTMLElement): boolean | void;
- }
- interface ManualRowMove extends Base {
- backlight: moveUI.BacklightUI;
- eventManager: EventManager;
- guideline: moveUI.GuidelineUI;
- removedRows: any[];
- rowsMapper: MoveRowsMapper;
- moveRow(row: number, target: number): void;
- moveRows(rows: number[], target: number): void;
- }
- interface ManualRowResize extends Base {
- autoresizeTimeout: (() => void) | void;
- currentRow: number | void;
- currentTH: HTMLElement | void;
- currentWidth: number | void;
- dblclick: number;
- eventManager: EventManager;
- guide: HTMLElement;
- handle: HTMLElement;
- manualRowHeights: any[];
- newSize: number | void;
- pressed: _Handsontable.Core | void;
- selectedRows: any[];
- startOffset: number | void;
- startWidth: number | void;
- startY: number | void;
- checkIfRowHeader(element: HTMLElement): boolean;
- clearManualSize(column: number): void;
- getTHFromTargetElement(element: HTMLElement): HTMLElement;
- hideHandleAndGuide(): void;
- loadManualRowHeights(): void;
- refreshGuidePosition(): void;
- refreshHandlePosition(): void;
- saveManualRowHeights(): void;
- setManualSize(column: number, width: number): number;
- setupGuidePosition(): void;
- setupHandlePosition(TH: HTMLElement): boolean | void;
- }
- interface MultipleSelectionHandles extends Base {
- dragged: any[];
- eventManager: EventManager;
- lastSetCell: HTMLElement | void;
- getCurrentRangeCoords(selectedRange: wot.CellRange, currentTouch: wot.CellCoords, touchStartDirection: string, currentDirection: string, draggedHandle: string): object;
- isDragged(): boolean;
- }
- interface GhostTableNestedHeaders {
- container: any;
- nestedHeaders: NestedHeaders;
- widthsCache: any[];
- clear(): void;
- }
- interface NestedHeaders extends Base {
- colspanArray: any[];
- columnHeaderLevelCount: number;
- ghostTable: GhostTableNestedHeaders;
- settings: any[];
- checkForFixedColumnsCollision(): void;
- checkForOverlappingHeaders(): void;
- getChildHeaders(row: number, column: number): any[];
- fillColspanArrayWithDummies(colspan: number, level: number): void;
- fillTheRemainingColspans(): void;
- getColspan(row: number, column: number): number;
- getNestedParent(level: number, column: number): any;
- headerRendererFactory(headerRow: number): () => void;
- levelToRowCoords(level: number): number;
- rowCoordsToLevel(row: number): number;
- setupColspanArray(): void;
- }
- interface DataManager {
- cache: object;
- data: object;
- hot: _Handsontable.Core;
- parentReference: any; // WeakMap
- plugin: NestedRows;
- addChild(parent: object, element?: object): void;
- addChildAtIndex(parent: object, index: number, element?: object, globalIndex?: number): void;
- addSibling(index: number, where?: string): void;
- countAllRows(): number;
- countChildren(parent: object | number): number;
- detachFromParent(elements: object | any[], forceRender?: boolean): void;
- getDataObject(row: number): any | void;
- getRowIndex(rowObj: object): number | void;
- getRowIndexWithinParent(row: number | object): number;
- getRowLevel(row: number): number | void;
- getRowParent(row: number | object): object | void;
- hasChildren(row: number | object): boolean;
- isParent(row: number | object): boolean;
- moveRow(fromIndex: number, toIndex: number): void;
- rewriteCache(): void;
- }
- interface NestedRows extends Base {
- bindRowsWithHeadersPlugin: BindRowsWithHeaders | void;
- dataManager: DataManager | void;
- headersUI: object | void;
- sourceData: object | void;
- trimRowsPlugin: TrimRows | void;
- }
- interface DataObserver {
- observedData: any[];
- observer: object;
- paused: boolean;
- destroy(): void;
- isPaused(): boolean;
- pause(): void;
- resume(): void;
- setObservedData(observedData: any): void;
- }
- interface ObserveChanges extends Base {
- observer: DataObserver | void;
- }
- interface TouchScroll extends Base {
- clones: any[];
- lockedCollection: boolean;
- scrollbars: any[];
- }
- interface TrimRows extends Base {
- trimmedRows: any[];
- removedRows: any[];
- rowsMapper: TrimRowsMapper;
- isTrimmed(row: number): boolean;
- trimRow(row: number): void;
- trimRows(rows: number[]): void;
- untrimAll(): void;
- untrimRow(row: number): void;
- untrimRows(rows: number[]): void;
- }
- interface Search extends Base {
- callback: () => void;
- queryMethod: () => void;
- searchResultClass: string;
- query(queryStr: string, callback: () => void, queryMethod: () => void): any[];
- getCallback(): () => void;
- setCallback(newCallback: () => void): void;
- getQueryMethod(): () => void;
- setQueryMethod(newQueryMethod: () => void): void;
- getSearchResultClass(): string;
- setSearchResultClass(newElementClass: string): void;
- }
- }
- namespace renderers {
- interface Base {
- (instance: _Handsontable.Core, TD: HTMLElement, row: number, col: number, prop: string | number, value: any, cellProperties: GridSettings): HTMLElement;
- }
- type Autocomplete = Base
- type Checkbox = Base
- type Html = Base
- type Numeric = Base
- type Password = Base
- type Text = Base
- }
- interface DefaultSettings extends GridSettings {
- }
- interface DefaultSettings extends Hooks {
- }
- interface GridSettings extends Hooks {
- activeHeaderClassName?: string;
- allowEmpty?: boolean;
- allowHtml?: boolean;
- allowInsertColumn?: boolean;
- allowInsertRow?: boolean;
- allowInvalid?: boolean;
- allowRemoveColumn?: boolean;
- allowRemoveRow?: boolean;
- autoColumnSize?: object | boolean;
- autoComplete?: any[];
- autoRowSize?: object | boolean;
- autoWrapCol?: boolean;
- autoWrapRow?: boolean;
- bindRowsWithHeaders?: boolean | string; // pro
- cell?: any[];
- cells?: (row?: number, col?: number, prop?: object) => GridSettings;
- checkedTemplate?: boolean | string;
- className?: string | any[];
- colHeaders?: ((index?: number) => void) | boolean | any[];
- collapsibleColumns?: boolean | any[]; // pro
- columnHeaderHeight?: number | any[];
- columns?: ((index?: number) => void) | any[];
- columnSorting?: boolean | columnSorting.Settings;
- columnSummary?: object; // pro
- colWidths?: ((index?: number) => void) | number | string | any[];
- commentedCellClassName?: string;
- comments?: boolean | CommentObject[];
- contextMenu?: boolean | any[] | contextMenu.Settings;
- contextMenuCopyPaste?: object;
- copyable?: boolean;
- copyColsLimit?: number;
- copyPaste?: boolean;
- copyRowsLimit?: number;
- correctFormat?: boolean;
- currentColClassName?: string;
- currentHeaderClassName?: string;
- currentRowClassName?: string;
- customBorders?: boolean | any[];
- data?: any | any[];
- dataSchema?: object;
- dateFormat?: string;
- numericFormat?: object;
- debug?: boolean;
- defaultDate?: string;
- disableVisualSelection?: boolean | string | any[];
- dragToScroll?: boolean;
- dropdownMenu?: boolean | object | any[]; // pro
- editor?: string | (() => void) | boolean;
- enterBeginsEditing?: boolean;
- enterMoves?: object | (() => void);
- fillHandle?: boolean | string | object;
- filter?: boolean;
- filteringCaseSensitive?: boolean;
- filters?: boolean; // pro
- fixedColumnsLeft?: number;
- fixedRowsBottom?: number; // pro
- fixedRowsTop?: number;
- fragmentSelection?: boolean | string;
- ganttChart?: object; // pro
- headerTooltips?: boolean | object; // pro
- height?: number | (() => void);
- hiddenColumns?: boolean | object; // pro
- hiddenRows?: boolean | object; // pro
- invalidCellClassName?: string;
- isEmptyCol?: (col: number) => boolean;
- isEmptyRow?: (row: number) => boolean;
- label?: object;
- language?: string;
- manualColumnFreeze?: boolean;
- manualColumnMove?: boolean | any[];
- manualColumnResize?: boolean | any[];
- manualRowMove?: boolean | any[];
- manualRowResize?: boolean | any[];
- maxCols?: number;
- maxRows?: number;
- mergeCells?: boolean | any[];
- minCols?: number;
- minRows?: number;
- minSpareCols?: number;
- minSpareRows?: number;
- multiColumnSorting?: boolean | multiColumnSorting.Settings;
- selectionMode?: 'single' | 'range' | 'multiple';
- nestedHeaders?: any[]; // pro
- noWordWrapClassName?: string;
- observeChanges?: boolean;
- observeDOMVisibility?: boolean;
- outsideClickDeselects?: boolean | ((target: HTMLElement) => boolean);
- pasteMode?: string;
- persistentState?: boolean;
- placeholder?: any;
- placeholderCellClassName?: string;
- preventOverflow?: string | boolean;
- readOnly?: boolean;
- readOnlyCellClassName?: string;
- renderAllRows?: boolean;
- renderer?: string | renderers.Base;
- rowHeaders?: boolean | any[] | ((index: number) => string | number);
- rowHeaderWidth?: number | any[];
- rowHeights?: any[] | (() => void) | number | string;
- search?: boolean;
- selectOptions?: any[];
- skipColumnOnPaste?: boolean;
- sortByRelevance?: boolean;
- source?: any[] | (() => void);
- startCols?: number;
- startRows?: number;
- stretchH?: string;
- strict?: boolean;
- tableClassName?: string | any[];
- tabMoves?: object;
- title?: string;
- trimDropdown?: boolean;
- trimRows?: boolean; // pro
- trimWhitespace?: boolean;
- type?: string;
- uncheckedTemplate?: boolean | string;
- undo?: boolean;
- valid?: boolean;
- validator?: (value: any, callback: (valid: boolean) => void) => void | RegExp;
- viewportColumnRenderingOffset?: number | string;
- viewportRowRenderingOffset?: number | string;
- visibleRows?: number;
- width?: number | (() => void);
- wordWrap?: boolean;
- // 自定义添加
- prop?: string;
- }
- interface Hooks {
- afterAddChild?: (parent: object, element: object | void, index: number | void) => void;
- afterBeginEditing?: (row: number, column: number) => void;
- afterCellMetaReset?: () => void;
- afterChange?: (changes: [number, string | number, any, any][], source: string) => void;
- afterChangesObserved?: () => void;
- afterColumnMove?: (startColumn: number, endColumn: number) => void;
- afterColumnResize?: (currentColumn: number, newSize: number, isDoubleClick: boolean) => void;
- afterColumnSort?: (currentSortConfig: object[], destinationSortConfigs: object[]) => void;
- afterContextMenuDefaultOptions?: (predefinedItems: any[]) => void;
- afterContextMenuHide?: (context: Handsontable.plugins.ContextMenu) => void;
- afterContextMenuShow?: (context: Handsontable.plugins.ContextMenu) => void;
- afterCopy?: (data: any[], coords: any[]) => void;
- afterCopyLimit?: (selectedRows: number, selectedColumnds: number, copyRowsLimit: number, copyColumnsLimit: number) => void;
- afterCreateCol?: (index: number, amount: number) => void;
- afterCreateRow?: (index: number, amount: number) => void;
- afterCut?: (data: any[], coords: any[]) => void;
- afterDeselect?: () => void;
- afterDestroy?: () => void;
- afterDetachChild?: (parent: object, element: object) => void;
- afterDocumentKeyDown?: (event: Event) => void;
- afterDrawSelection?: (currentRow: number, currentColumn: number, cornersOfSelection: number[], layerLevel: number | void) => string | void
- afterDropdownMenuDefaultOptions?: (predefinedItems: any[]) => void;
- afterDropdownMenuHide?: (instance: Handsontable.plugins.DropdownMenu) => void;
- afterDropdownMenuShow?: (instance: Handsontable.plugins.DropdownMenu) => void;
- afterFilter?: (formulasStack: any[]) => void;
- afterGetCellMeta?: (row: number, col: number, cellProperties: GridSettings) => void;
- afterGetColHeader?: (col: number, TH: Element) => void;
- afterGetColumnHeaderRenderers?: (array: any[]) => void;
- afterGetRowHeader?: (row: number, TH: Element) => void;
- afterGetRowHeaderRenderers?: (array: any[]) => void;
- afterInit?: () => void;
- afterLanguageChange?: (languageCode: string) => void;
- afterListen?: () => void;
- afterLoadData?: (firstTime: boolean) => void;
- afterMergeCells?: (cellRange: wot.CellRange, mergeParent: object, auto: boolean) => void;
- afterModifyTransformEnd?: (coords: wot.CellCoords, rowTransformDir: number, colTransformDir: number) => void;
- afterModifyTransformStart?: (coords: wot.CellCoords, rowTransformDir: number, colTransformDir: number) => void;
- afterMomentumScroll?: () => void;
- afterOnCellContextMenu?: (event: MouseEvent, coords: wot.CellCoords, TD: Element) => void;
- afterOnCellCornerDblClick?: (event: MouseEvent) => void;
- afterOnCellCornerMouseDown?: (event: MouseEvent) => void;
- afterOnCellMouseDown?: (event: MouseEvent, coords: wot.CellCoords, TD: Element) => void;
- afterOnCellMouseOver?: (event: MouseEvent, coords: wot.CellCoords, TD: Element) => void;
- afterOnCellMouseOut?: (event: MouseEvent, coords: wot.CellCoords, TD: Element) => void;
- afterOnCellMouseUp?: (event: MouseEvent, coords: wot.CellCoords, TD: Element) => void;
- afterPaste?: (data: any[], coords: any[]) => void;
- afterPluginsInitialized?: () => void;
- afterRedo?: (action: object) => void;
- afterRemoveCellMeta?: (row: number, column: number, key: string, value: any) => void;
- afterRemoveCol?: (index: number, amount: number) => void;
- afterRemoveRow?: (index: number, amount: number) => void;
- afterRender?: (isForced: boolean) => void;
- afterRenderer?: (TD: Element, row: number, col: number, prop: string | number, value: string, cellProperties: GridSettings) => void;
- afterRowMove?: (startRow: number, endRow: number) => void;
- afterRowResize?: (currentRow: number, newSize: number, isDoubleClick: boolean) => void;
- afterScrollHorizontally?: () => void;
- afterScrollVertically?: () => void;
- afterSelection?: (r: number, c: number, r2: number, c2: number, preventScrolling: object, selectionLayerLevel: number) => void;
- afterSelectionByProp?: (r: number, p: string, r2: number, p2: string, preventScrolling: object, selectionLayerLevel: number) => void;
- afterSelectionEnd?: (r: number, c: number, r2: number, c2: number, selectionLayerLevel: number) => void;
- afterSelectionEndByProp?: (r: number, p: string, r2: number, p2: string, selectionLayerLevel: number) => void;
- afterSetCellMeta?: (row: number, col: number, key: string, value: any) => void;
- afterSetDataAtCell?: (changes: any[], source?: string) => void;
- afterSetDataAtRowProp?: (changes: any[], source?: string) => void;
- afterTrimRow?: (rows: any[]) => void;
- afterUndo?: (action: object) => void;
- afterUnlisten?: () => void;
- afterUnmergeCells?: (cellRange: wot.CellRange, auto: boolean) => void;
- afterUntrimRow?: (rows: any[]) => void;
- afterUpdateSettings?: () => void;
- afterValidate?: (isValid: boolean, value: any, row: number, prop: string | number, source: string) => void | boolean;
- afterViewportColumnCalculatorOverride?: (calc: object) => void;
- afterViewportRowCalculatorOverride?: (calc: object) => void;
- beforeAddChild?: (parent: object, element: object | void, index: number | void) => void;
- beforeAutofill?: (start: object, end: object, data: any[]) => void;
- beforeAutofillInsidePopulate?: (index: object, direction: string, input: any[], deltas: any[]) => void;
- beforeCellAlignment?: (stateBefore: any, range: any, type: string, alignmentClass: string) => void;
- beforeChange?: (changes: [number, string | number, any, any][], source: string) => void;
- beforeChangeRender?: (changes: any[], source: string) => void;
- beforeColumnMove?: (columns: number[], target: number) => void;
- beforeColumnResize?: (currentColumn: number, newSize: number, isDoubleClick: boolean) => void;
- beforeColumnSort?: (currentSortConfig: object[], destinationSortConfigs: object[]) => void;
- beforeContextMenuSetItems?: (menuItems: any[]) => void;
- beforeContextMenuShow?: (context: Handsontable.plugins.ContextMenu) => void;
- beforeCopy?: (data: any[], coords: any[]) => any;
- beforeCreateCol?: (index: number, amount: number, source?: string) => void;
- beforeCreateRow?: (index: number, amount: number, source?: string) => void;
- beforeCut?: (data: any[], coords: any[]) => any;
- beforeDetachChild?: (parent: object, element: object) => void;
- beforeDrawBorders?: (corners: any[], borderClassName: string) => void;
- beforeDropdownMenuSetItems?: (menuItems: any[]) => void;
- beforeDropdownMenuShow?: (instance: Handsontable.plugins.DropdownMenu) => void;
- beforeFilter?: (formulasStack: any[]) => void;
- beforeGetCellMeta?: (row: number, col: number, cellProperties: GridSettings) => void;
- beforeInit?: () => void;
- beforeInitWalkontable?: (walkontableConfig: object) => void;
- beforeKeyDown?: (event: Event) => void;
- beforeLanguageChange?: (languageCode: string) => void;
- beforeMergeCells?: (cellRange: wot.CellRange, auto: boolean) => void;
- beforeOnCellContextMenu?: (event: object, coords: object, TD: Element) => void;
- beforeOnCellMouseDown?: (event: Event, coords: object, TD: Element, controller: object) => void;
- beforeOnCellMouseOut?: (event: Event, coords: wot.CellCoords, TD: Element) => void;
- beforeOnCellMouseOver?: (event: Event, coords: wot.CellCoords, TD: Element, controller: object) => void;
- beforeOnCellMouseUp?: (event: Event, coords: wot.CellCoords, TD: Element, controller: object) => void;
- beforePaste?: (data: any[], coords: any[]) => any;
- beforeRemoveCellClassNames?: () => string[] | void;
- beforeRemoveCellMeta?: (row: number, column: number, key: string, value: any) => void;
- beforeRedo?: (action: object) => void;
- beforeRemoveCol?: (index: number, amount: number, logicalCols?: any[]) => void;
- beforeRemoveRow?: (index: number, amount: number, logicalRows?: any[]) => void;
- beforeRender?: (isForced: boolean, skipRender: object) => void;
- beforeRenderer?: (TD: Element, row: number, col: number, prop: string | number, value: string, cellProperties: GridSettings) => void;
- beforeRowMove?: (columns: number[], target: number) => void;
- beforeRowResize?: (currentRow: number, newSize: number, isDoubleClick: boolean) => any;
- beforeSetRangeEnd?: (coords: wot.CellCoords) => void;
- beforeSetRangeStart?: (coords: wot.CellCoords) => void;
- beforeSetRangeStartOnly?: (coords: wot.CellCoords) => void;
- beforeStretchingColumnWidth?: (stretchedWidth: number, column: number) => void;
- beforeTouchScroll?: () => void;
- beforeUndo?: (action: object) => void;
- beforeUnmergeCells?: (cellRange: wot.CellRange, auto: boolean) => void;
- beforeValidate?: (value: any, row: number, prop: string | number, source?: string) => void;
- beforeValueRender?: (value: any, cellProperties: object) => void;
- construct?: () => void;
- getRegistered?: () => string[];
- hiddenColumn?: (column: number) => void;
- hiddenRow?: (row: number) => void;
- init?: () => void;
- manualRowHeights?: (state: any[]) => void;
- modifyAutofillRange?: (startArea: any[], entireArea: any[]) => void;
- modifyCol?: (col: number) => void;
- modifyColHeader?: (column: number) => void;
- modifyColumnHeaderHeight?: () => void;
- modifyColWidth?: (width: number, col: number) => void;
- modifyCopyableRange?: (copyableRanges: any[]) => void;
- modifyData?: (row: number, column: number, valueHolder: object, ioMode: string) => void;
- modifyGetCellCoords?: (row: number, column: number, topmost: boolean) => void;
- modifyRow?: (row: number) => void;
- modifyRowData?: (row: number) => void;
- modifyRowHeader?: (row: number) => void;
- modifyRowHeaderWidth?: (rowHeaderWidth: number) => void;
- modifyRowHeight?: (height: number, row: number) => void;
- modifyRowSourceData?: (row: number) => void;
- modifyTransformEnd?: (delta: wot.CellCoords) => void;
- modifyTransformStart?: (delta: wot.CellCoords) => void;
- persistentStateLoad?: (key: string, valuePlaceholder: object) => void;
- persistentStateReset?: (key: string) => void;
- persistentStateSave?: (key: string, value: any) => void;
- skipLengthCache?: (delay: number) => void;
- unmodifyCol?: (col: number) => void;
- unmodifyRow?: (row: number) => void;
- destroy?: (instance?: Handsontable) => void;
- }
- namespace I18n {
- type LanguageDictionary = {
- [phraseKey: string]: string | string[];
- languageCode: string;
- };
- interface Internationalization {
- dictionaryKeys: I18n.LanguageDictionary;
- registerLanguageDictionary: (languageCodeOrDictionary: LanguageDictionary | string, dictionary?: LanguageDictionary) => LanguageDictionary;
- getTranslatedPhrase: (dictionaryKey: string, extraArguments?: any) => string | null;
- getLanguagesDictionaries: () => LanguageDictionary[];
- getLanguageDictionary: (languageCode: string) => LanguageDictionary;
- }
- }
- interface CellTypes {
- autocomplete: cellTypes.Autocomplete;
- checkbox: cellTypes.Checkbox;
- date: cellTypes.Date;
- dropdown: cellTypes.Dropdown;
- handsontable: cellTypes.Handsontable;
- numeric: cellTypes.Numeric;
- password: cellTypes.Password;
- text: cellTypes.Text;
- time: cellTypes.Time;
- // 自定义添加
- registerCellType:(name:string, type:{editor: any; renderer: Handsontable.renderers.Base; validator?: (value: any, callback: (valid: boolean) => void) => void;})=> void
- }
- interface Editors {
- AutocompleteEditor: typeof Handsontable._editors.Autocomplete;
- BaseEditor: typeof Handsontable._editors.Base;
- CheckboxEditor: typeof Handsontable._editors.Checkbox;
- DateEditor: typeof Handsontable._editors.Date;
- DropdownEditor: typeof Handsontable._editors.Dropdown;
- HandsontableEditor: typeof Handsontable._editors.Handsontable;
- MobileEditor: typeof Handsontable._editors.Mobile;
- NumericEditor: typeof Handsontable._editors.Numeric;
- PasswordEditor: typeof Handsontable._editors.Password;
- SelectEditor: typeof Handsontable._editors.Select;
- TextEditor: typeof Handsontable._editors.Text;
- getEditor: (editorName: string, hotInstance: Handsontable) => any;
- registerEditor: (editorName: string, editorClass: any) => void;
- }
- interface Renderers {
- AutocompleteRenderer: renderers.Autocomplete;
- BaseRenderer: renderers.Base;
- CheckboxRenderer: renderers.Checkbox;
- HtmlRenderer: renderers.Html;
- NumericRenderer: renderers.Numeric;
- PasswordRenderer: renderers.Password;
- TextRenderer: renderers.Text;
- // 自定义添加
- registerRenderer: (rendererName: string, rendererFunc: Handsontable.renderers.Base) => void;
- }
- interface Helper {
- readonly KEY_CODES: {
- A: number,
- ALT: number,
- ARROW_DOWN: number,
- ARROW_LEFT: number,
- ARROW_RIGHT: number,
- ARROW_UP: number,
- BACKSPACE: number,
- C: number,
- CAPS_LOCK: number,
- COMMA: number,
- COMMAND_LEFT: number,
- COMMAND_RIGHT: number,
- CONTROL_LEFT: number,
- DELETE: number,
- END: number,
- ENTER: number,
- ESCAPE: number,
- F1: number,
- F2: number,
- F3: number,
- F4: number,
- F5: number,
- F6: number,
- F7: number,
- F8: number,
- F9: number,
- F10: number,
- F11: number,
- F12: number,
- HOME: number,
- INSERT: number,
- MOUSE_LEFT: number,
- MOUSE_MIDDLE: number,
- MOUSE_RIGHT: number,
- PAGE_DOWN: number,
- PAGE_UP: number,
- PERIOD: number,
- SHIFT: number,
- SPACE: number,
- TAB: number,
- V: number,
- X: number
- },
- arrayAvg(array: any[]): number,
- arrayEach(array: any[], iteratee: (value: any, index: number, array: any[]) => void): any[],
- arrayFilter(array: any[], predicate: (value: any, index: number, array: any[]) => void): any[],
- arrayFlatten(array: any[]): any[],
- arrayIncludes(array: any[], searchElement: any, fromIndex: number): any[],
- arrayMap(array: any[], iteratee: (value: any, index: number, array: any[]) => void): any[],
- arrayMax(array: any[]): number,
- arrayMin(array: any[]): number,
- arrayReduce(array: any[], iteratee: (value: any, index: number, array: any[]) => void, accumulator: any, initFromArray: boolean): any,
- arraySum(array: any[]): number,
- arrayUnique(array: any[]): any[],
- cancelAnimationFrame(id: number): void,
- cellMethodLookupFactory(methodName: string, allowUndefined: boolean): void,
- clone(object: object): object,
- columnFactory(GridSettings: GridSettings, conflictList: any[]): object,
- createEmptySpreadsheetData(rows: number, columns: number): any[],
- createObjectPropListener(defaultValue?: any, propertyToListen?: string): object,
- createSpreadsheetData(rows?: number, columns?: number): any[],
- createSpreadsheetObjectData(rows?: number, colCount?: number): any[],
- curry(func: () => void): () => void,
- curryRight(func: () => void): () => void,
- debounce(func: () => void, wait?: number): () => void,
- deepClone(obj: object): object,
- deepExtend(target: object, extension: object): void,
- deepObjectSize(object: object): number,
- defineGetter(object: object, property: any, value: any, options: object): void,
- duckSchema(object: any[] | object): any[] | object,
- endsWith(string: string, needle: string): boolean,
- equalsIgnoreCase(...string: string[]): boolean,
- extend(target: object, extension: object): void,
- extendArray(arr: any[], extension: any[]): void,
- getComparisonFunction(language: string, options?: object): any | void,
- getNormalizedDate(dateString: string): Date,
- getProperty(object: object, name: string): any | void,
- getPrototypeOf(obj: object): any | void,
- hasCaptionProblem(): boolean | void,
- inherit(Child: object, Parent: object): object,
- isChrome(): boolean,
- isCtrlKey(keyCode: number): boolean,
- isDefined(variable: any): boolean,
- isEdge(): boolean,
- isEmpty(variable: any): boolean,
- isFunction(func: any): boolean,
- isIE(): boolean,
- isIE8(): boolean,
- isIE9(): boolean,
- isKey(keyCode: number, baseCode: string): boolean
- isMetaKey(keyCode: number): boolean,
- isMobileBrowser(): boolean,
- isMSBrowser(): boolean,
- isNumeric(n: any): boolean,
- isObject(obj: any): boolean,
- isObjectEqual(object1: object | any[], object2: object | any[]): boolean,
- isPercentValue(value: string): boolean,
- isPrintableChar(keyCode: number): boolean,
- isSafari(): boolean,
- isTouchSupported(): boolean,
- isUndefined(variable: any): boolean,
- isWebComponentSupportedNatively(): boolean,
- mixin(Base: object, ...mixins: object[]): object,
- objectEach(object: object, iteratee: (value: any, key: any, object: object) => void): object,
- padStart(string: string, maxLength: number, fillString?: string): string,
- partial(func: () => void, ...params: any[]): () => void,
- pipe(...functions: (() => void)[]): () => void,
- pivot(arr: any[]): any[],
- randomString(): string,
- rangeEach(rangeFrom: number, rangeTo: number, iteratee: (index: number) => void): void,
- rangeEachReverse(rangeFrom: number, rangeTo: number, iteratee: (index: number) => void): void,
- requestAnimationFrame(callback: () => void): number,
- spreadsheetColumnIndex(label: string): number,
- spreadsheetColumnLabel(index: number): string,
- startsWith(string: string, needle: string): boolean,
- stringify(value: any): string,
- stripTags(string: string): string,
- substitute(template: string, variables?: object): string,
- throttle(func: () => void, wait?: number): () => void,
- throttleAfterHits(func: () => void, wait?: number, hits?: number): () => void,
- to2dArray(arr: any[]): void,
- toUpperCaseFirst(string: string): string,
- translateRowsToColumns(input: any[]): any[],
- valueAccordingPercent(value: number, percent: string | number): number
- }
- interface Dom {
- HTML_CHARACTERS: RegExp,
- addClass: (element: HTMLElement, className: string | any[]) => void;
- addEvent: (element: HTMLElement, event: string, callback: () => void) => void;
- closest: (element: HTMLElement, nodes: any[], until?: HTMLElement) => HTMLElement | void;
- closestDown: (element: HTMLElement, nodes: any[], until?: HTMLElement) => HTMLElement | void;
- empty: (element: HTMLElement) => void;
- fastInnerHTML: (element: HTMLElement, content: string) => void;
- fastInnerText: (element: HTMLElement, content: string) => void;
- getCaretPosition: (el: HTMLElement) => number;
- getComputedStyle: (element: HTMLElement) => CSSStyleDeclaration | object;
- getCssTransform: (element: HTMLElement) => number | void;
- getParent: (element: HTMLElement, level?: number) => HTMLElement | void;
- getScrollLeft: (element: HTMLElement) => number;
- getScrollTop: (element: HTMLElement) => number;
- getScrollableElement: (element: HTMLElement) => HTMLElement;
- getScrollbarWidth: () => number;
- getSelectionEndPosition: (el: HTMLElement) => number;
- getSelectionText: () => string;
- getStyle: (element: HTMLElement, prop: string) => string;
- getTrimmingContainer: (base: HTMLElement) => HTMLElement;
- getWindowScrollLeft: () => number;
- getWindowScrollTop: () => number;
- hasClass: (element: HTMLElement, className: string) => boolean;
- hasHorizontalScrollbar: (element: HTMLElement) => boolean;
- hasVerticalScrollbar: (element: HTMLElement) => boolean;
- index: (element: Element) => number;
- innerHeight: (element: HTMLElement) => number;
- innerWidth: (element: HTMLElement) => number;
- isChildOf: (child: HTMLElement, parent: object | string) => boolean;
- isChildOfWebComponentTable: (element: Element) => boolean;
- isImmediatePropagationStopped: (event: Event) => boolean;
- isInput: (element: HTMLElement) => boolean;
- isLeftClick: (event: Event) => boolean;
- isOutsideInput: (element: HTMLElement) => boolean;
- isRightClick: (event: Event) => boolean;
- isVisible: (elem: HTMLElement) => boolean;
- offset: (elem: HTMLElement) => object;
- outerHeight: (elem: HTMLElement) => number;
- outerWidth: (element: HTMLElement) => number;
- overlayContainsElement: (overlayType: string, element: HTMLElement) => boolean;
- pageX: (event: Event) => number;
- pageY: (event: Event) => number;
- polymerUnwrap: (element: HTMLElement) => any | void;
- polymerWrap: (element: HTMLElement) => any | void;
- removeClass: (element: HTMLElement, className: string | any[]) => void;
- removeEvent: (element: HTMLElement, event: string, callback: () => void) => void;
- removeTextNodes: (element: HTMLElement, parent: HTMLElement) => void;
- resetCssTransform: (element: HTMLElement) => void;
- setCaretPosition: (element: HTMLElement, pos: number, endPos: number) => void;
- setOverlayPosition: (overlayElem: HTMLElement, left: number, top: number) => void;
- stopImmediatePropagation: (event: Event) => void;
- stopPropagation: (event: Event) => void;
- }
- interface Plugins {
- AutoColumnSize: plugins.AutoColumnSize,
- Autofill: plugins.Autofill,
- AutoRowSize: plugins.AutoRowSize,
- BasePlugin: plugins.Base,
- BindRowsWithHeaders: plugins.BindRowsWithHeaders,
- CollapsibleColumns: plugins.CollapsibleColumns,
- ColumnSorting: plugins.ColumnSorting,
- ColumnSummary: plugins.ColumnSummary,
- Comments: plugins.Comments,
- ContextMenu: plugins.ContextMenu,
- CopyPaste: plugins.CopyPaste,
- DragToScroll: plugins.DragToScroll,
- DropdownMenu: plugins.DropdownMenu,
- ExportFile: plugins.ExportFile,
- Filters: plugins.Filters,
- Formulas: plugins.Formulas,
- GanttChart: plugins.GanttChart,
- HeaderTooltips: plugins.HeaderTooltips,
- HiddenColumns: plugins.HiddenColumns,
- HiddenRows: plugins.HiddenRows,
- ManualColumnFreeze: plugins.ManualColumnFreeze,
- ManualColumnMove: plugins.ManualColumnMove,
- ManualColumnResize: plugins.ManualColumnResize,
- ManualRowMove: plugins.ManualRowMove,
- ManualRowResize: plugins.ManualRowResize;
- MergeCells: plugins.MergeCells;
- MultiColumnSorting: plugins.MultiColumnSorting,
- MultipleSelectionHandles: plugins.MultipleSelectionHandles,
- NestedHeaders: plugins.NestedHeaders,
- NestedRows: plugins.NestedRows,
- ObserveChanges: plugins.ObserveChanges,
- Search: plugins.Search,
- TouchScroll: plugins.TouchScroll,
- TrimRows: plugins.TrimRows,
- registerPlugin: () => void
- }
- // Plugin collection, map for getPlugin method
- interface PluginsCollection {
- autoColumnSize: plugins.AutoColumnSize,
- autofill: plugins.Autofill,
- autoRowSize: plugins.AutoRowSize,
- bindRowsWithHeaders: plugins.BindRowsWithHeaders,
- collapsibleColumns: plugins.CollapsibleColumns,
- columnSorting: plugins.ColumnSorting,
- columnSummary: plugins.ColumnSummary,
- comments: plugins.Comments,
- contextMenu: plugins.ContextMenu,
- copyPaste: plugins.CopyPaste,
- dragToScroll: plugins.DragToScroll,
- dropdownMenu: plugins.DropdownMenu,
- exportFile: plugins.ExportFile,
- filters: plugins.Filters,
- formulas: plugins.Formulas,
- ganttChart: plugins.GanttChart,
- headerTooltips: plugins.HeaderTooltips,
- hiddenColumns: plugins.HiddenColumns,
- hiddenRows: plugins.HiddenRows,
- manualColumnFreeze: plugins.ManualColumnFreeze,
- manualColumnMove: plugins.ManualColumnMove,
- manualColumnResize: plugins.ManualColumnResize,
- manualRowMove: plugins.ManualRowMove,
- manualRowResize: plugins.ManualRowResize;
- mergeCells: plugins.MergeCells;
- multiColumnSorting: plugins.MultiColumnSorting,
- multipleSelectionHandles: plugins.MultipleSelectionHandles,
- nestedHeaders: plugins.NestedHeaders,
- nestedRows: plugins.NestedRows,
- observeChanges: plugins.ObserveChanges,
- search: plugins.Search,
- touchScroll: plugins.TouchScroll,
- trimRows: plugins.TrimRows,
- }
- // plugins
- // Comments
- interface CommentObject {
- row: number,
- col: number,
- comment?: {
- value?: string,
- readOnly?: boolean,
- style?: {
- height?: number,
- width?: number
- }
- }
- }
- // ContextMenu
- namespace contextMenu {
- interface Options {
- start: wot.CellCoords,
- end: wot.CellCoords
- }
- interface Settings {
- callback: (key: string, options: contextMenu.Options) => void;
- items: any;
- }
- }
- namespace columnSorting {
- type SortOrderType = 'asc' | 'desc';
- type Config = { column: number, sortOrder: SortOrderType }
- interface Settings {
- initialConfig?: Config,
- sortEmptyCells?: boolean,
- indicator?: boolean,
- headerAction?: boolean,
- compareFunctionFactory?: ((sortOrder: SortOrderType, columnMeta: GridSettings) =>
- (value: any, nextValue: any) => -1 | 0 | 1)
- }
- }
- namespace multiColumnSorting {
- interface Settings {
- initialConfig?: columnSorting.Config | Array<columnSorting.Config>,
- sortEmptyCells?: boolean,
- indicator?: boolean,
- headerAction?: boolean,
- compareFunctionFactory?: ((sortOrder: columnSorting.SortOrderType, columnMeta: GridSettings) =>
- (value: any, nextValue: any) => -1 | 0 | 1)
- }
- }
- }
- declare class Handsontable extends _Handsontable.Core {
- static baseVersion: string;
- static buildDate: string;
- static packageName: string;
- static version: string;
- static cellTypes: Handsontable.CellTypes;
- static languages: Handsontable.I18n.Internationalization;
- static dom: Handsontable.Dom;
- static editors: Handsontable.Editors;
- static helper: Handsontable.Helper;
- static hooks: Handsontable.Hooks;
- static plugins: Handsontable.Plugins;
- static renderers: Handsontable.Renderers;
- // 自定义添加
- rendererCache?: any;
- }
- export = Handsontable;
- export as namespace Handsontable;
|