| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792 |
- 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): 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;
- }
- 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 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})=> 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;
|