settings.types.ts 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
  1. import * as Handsontable from 'handsontable';
  2. const hotSettings: Handsontable.GridSettings = {
  3. activeHeaderClassName: 'foo',
  4. allowEmpty: true,
  5. allowHtml: true,
  6. allowInsertColumn: true,
  7. allowInsertRow: true,
  8. allowInvalid: true,
  9. allowRemoveColumn: true,
  10. allowRemoveRow: true,
  11. autoColumnSize: true,
  12. autoComplete: [],
  13. autoRowSize: true,
  14. autoWrapCol: true,
  15. autoWrapRow: true,
  16. bindRowsWithHeaders: 'foo',
  17. cell: [],
  18. cells: function() {
  19. return {};
  20. },
  21. checkedTemplate: true,
  22. className: [],
  23. colHeaders: true,
  24. collapsibleColumns: true,
  25. columnHeaderHeight: 123,
  26. columns: [],
  27. columnSorting: {},
  28. columnSummary: {},
  29. colWidths: 123,
  30. commentedCellClassName: 'foo',
  31. comments: [],
  32. contextMenu: true,
  33. contextMenuCopyPaste: {},
  34. copyable: true,
  35. copyColsLimit: 123,
  36. copyPaste: true,
  37. copyRowsLimit: 123,
  38. correctFormat: true,
  39. currentColClassName: 'foo',
  40. currentHeaderClassName: 'foo',
  41. currentRowClassName: 'foo',
  42. customBorders: true,
  43. data: [],
  44. dataSchema: {},
  45. dateFormat: 'foo',
  46. debug: true,
  47. defaultDate: 'foo',
  48. disableVisualSelection: true,
  49. dragToScroll: false,
  50. dropdownMenu: [],
  51. editor: true,
  52. enterBeginsEditing: true,
  53. enterMoves: {},
  54. fillHandle: true,
  55. filter: true,
  56. filteringCaseSensitive: true,
  57. filters: false,
  58. fixedColumnsLeft: 123,
  59. fixedRowsBottom: 123,
  60. fixedRowsTop: 123,
  61. numericFormat: {},
  62. fragmentSelection: true,
  63. ganttChart: {},
  64. headerTooltips: true,
  65. height: 123,
  66. hiddenColumns: true,
  67. hiddenRows: {},
  68. invalidCellClassName: 'foo',
  69. isEmptyCol: (col) => { return true; },
  70. isEmptyRow: (row) => { return true; },
  71. label: {},
  72. language: 'foo',
  73. manualColumnFreeze: true,
  74. manualColumnMove: true,
  75. manualColumnResize: true,
  76. manualRowMove: true,
  77. manualRowResize: true,
  78. maxCols: 123,
  79. maxRows: 123,
  80. mergeCells: true,
  81. minCols: 123,
  82. minRows: 123,
  83. minSpareCols: 123,
  84. minSpareRows: 123,
  85. multiColumnSorting: {},
  86. selectionMode: 'single',
  87. nestedHeaders: [],
  88. noWordWrapClassName: 'foo',
  89. observeChanges: true,
  90. observeDOMVisibility: true,
  91. outsideClickDeselects: true,
  92. pasteMode: 'foo',
  93. persistentState: true,
  94. placeholder: 123,
  95. placeholderCellClassName: 'foo',
  96. preventOverflow: true,
  97. readOnly: true,
  98. readOnlyCellClassName: 'foo',
  99. renderAllRows: true,
  100. renderer: 'foo',
  101. rowHeaders: true,
  102. rowHeaderWidth: 123,
  103. rowHeights: 123,
  104. search: true,
  105. selectOptions: [],
  106. skipColumnOnPaste: true,
  107. sortByRelevance: true,
  108. source: [],
  109. startCols: 123,
  110. startRows: 123,
  111. stretchH: 'foo',
  112. strict: true,
  113. tableClassName: 'foo',
  114. tabMoves: {},
  115. title: 'foo',
  116. trimDropdown: true,
  117. trimRows: true,
  118. trimWhitespace: true,
  119. type: 'foo',
  120. uncheckedTemplate: true,
  121. undo: true,
  122. validator: function() {},
  123. viewportColumnRenderingOffset: 123,
  124. viewportRowRenderingOffset: 123,
  125. visibleRows: 123,
  126. width: 1232,
  127. wordWrap: true,
  128. // Hooks via settings object
  129. afterAddChild: (parent, element, index) => {},
  130. afterBeginEditing: (row, column) => {},
  131. afterCellMetaReset: () => {},
  132. afterChange: (changes, source) => {},
  133. afterChangesObserved: () => {},
  134. afterColumnMove: (startColumn, endColumn) => {},
  135. afterColumnResize: (currentColumn, newSize, isDoubleClick) => {},
  136. afterColumnSort: (currentSortConfig, destinationSortConfigs) => {},
  137. afterContextMenuDefaultOptions: (predefinedItems) => {},
  138. afterContextMenuHide: (context) => {},
  139. afterContextMenuShow: (context) => {},
  140. afterCopy: (data, coords) => {},
  141. afterCopyLimit: (selectedRows, selectedColumnds, copyRowsLimit, copyColumnsLimit) => {},
  142. afterCreateCol: (index, amount) => {},
  143. afterCreateRow: (index, amount) => {},
  144. afterCut: (data, coords) => {},
  145. afterDeselect: () => {},
  146. afterDestroy: () => {},
  147. afterDetachChild: (parent, element) => {},
  148. afterDocumentKeyDown: (event) => {},
  149. afterDrawSelection: (currentRow, currentColumn, cornersOfSelection, layerLevel) => {},
  150. afterDropdownMenuDefaultOptions: (predefinedItems) => {},
  151. afterDropdownMenuHide: (instance) => {},
  152. afterDropdownMenuShow: (instance) => {},
  153. afterFilter: (formulasStack) => {},
  154. afterGetCellMeta: (row, col, cellProperties) => {},
  155. afterGetColHeader: (col, TH) => {},
  156. afterGetColumnHeaderRenderers: (array) => {},
  157. afterGetRowHeader: (row, TH) => {},
  158. afterGetRowHeaderRenderers: (array) => {},
  159. afterInit: () => {},
  160. afterLanguageChange: (languageCode) => {},
  161. afterListen: () => {},
  162. afterLoadData: (firstTime) => {},
  163. afterMergeCells: (cellRange, mergeParent, auto) => {},
  164. afterModifyTransformEnd: (coords, rowTransformDir, colTransformDir) => {},
  165. afterModifyTransformStart: (coords, rowTransformDir, colTransformDir) => {},
  166. afterMomentumScroll: () => {},
  167. afterOnCellContextMenu: (event, coords, TD) => {},
  168. afterOnCellCornerDblClick: (event) => {},
  169. afterOnCellCornerMouseDown: (event) => {},
  170. afterOnCellMouseDown: (event, coords, TD) => {},
  171. afterOnCellMouseOver: (event, coords, TD) => {},
  172. afterOnCellMouseOut: (event, coords, TD) => {},
  173. afterOnCellMouseUp: (event, coords, TD) => {},
  174. afterPaste: (data, coords) => {},
  175. afterPluginsInitialized: () => {},
  176. afterRedo: (action) => {},
  177. afterRemoveCellMeta: (row, column, key, value) => {},
  178. afterRemoveCol: (index, amount) => {},
  179. afterRemoveRow: (index, amount) => {},
  180. afterRender: (isForced) => {},
  181. afterRenderer: (TD, row, col, prop, value, cellProperties) => {},
  182. afterRowMove: (startRow, endRow) => {},
  183. afterRowResize: (currentRow, newSize, isDoubleClick) => {},
  184. afterScrollHorizontally: () => {},
  185. afterScrollVertically: () => {},
  186. afterSelection: (r, c, r2, c2, preventScrolling, selectionLayerLevel) => {},
  187. afterSelectionByProp: (r, p, r2, p2, preventScrolling, selectionLayerLevel) => {},
  188. afterSelectionEnd: (r, c, r2, c2, selectionLayerLevel) => {},
  189. afterSelectionEndByProp: (r, p, r2, p2, selectionLayerLevel) => {},
  190. afterSetCellMeta: (row, col, key, value) => {},
  191. afterSetDataAtCell: (changes, source) => {},
  192. afterSetDataAtRowProp: (changes, source) => {},
  193. afterTrimRow: (rows) => {},
  194. afterUndo: (action) => {},
  195. afterUnlisten: () => {},
  196. afterUnmergeCells: (cellRange, auto) => {},
  197. afterUntrimRow: (rows) => {},
  198. afterUpdateSettings: () => {},
  199. afterValidate: () => {},
  200. afterViewportColumnCalculatorOverride: (calc) => {},
  201. afterViewportRowCalculatorOverride: (calc) => {},
  202. beforeAddChild: (parent, element, index) => {},
  203. beforeAutofill: (start, end, data) => {},
  204. beforeAutofillInsidePopulate: (index, direction, input, deltas) => {},
  205. beforeCellAlignment: (stateBefore, range, type, alignmentClass) => {},
  206. beforeChange: (changes, source) => {},
  207. beforeChangeRender: (changes, source) => {},
  208. beforeColumnMove: (startColumn, endColumn) => {},
  209. beforeColumnResize: (currentColumn, newSize, isDoubleClick) => {},
  210. beforeColumnSort: (currentSortConfig, destinationSortConfigs) => {},
  211. beforeContextMenuSetItems: (menuItems) => {},
  212. beforeContextMenuShow: (context) => {},
  213. beforeCopy: (data, coords) => {},
  214. beforeCreateCol: (index, amount, source) => {},
  215. beforeCreateRow: (index, amount, source) => {},
  216. beforeCut: (data, coords) => {},
  217. beforeDetachChild: (parent, element) => {},
  218. beforeDrawBorders: (corners, borderClassName) => {},
  219. beforeDropdownMenuSetItems: (menuItems) => {},
  220. beforeDropdownMenuShow: (instance) => {},
  221. beforeFilter: (formulasStack) => {},
  222. beforeGetCellMeta: (row, col, cellProperties) => {},
  223. beforeInit: () => {},
  224. beforeInitWalkontable: (walkontableConfig) => {},
  225. beforeKeyDown: (event) => {},
  226. beforeLanguageChange: (languageCode) => {},
  227. beforeMergeCells: (cellRange, auto) => {},
  228. beforeOnCellContextMenu: (event, coords, TD) => {},
  229. beforeOnCellMouseDown: (event, coords, TD, controller) => {},
  230. beforeOnCellMouseOut: (event, coords, TD) => {},
  231. beforeOnCellMouseOver: (event, coords, TD, controller) => {},
  232. beforeOnCellMouseUp: (event, coords, TD, controller) => {},
  233. beforePaste: (data, coords) => {},
  234. beforeRemoveCellClassNames: () => {},
  235. beforeRemoveCellMeta: (row, column, key, value) => {},
  236. beforeRedo: (action) => {},
  237. beforeRemoveCol: (index, amount, logicalCols = [1, 2, 3]) => {},
  238. beforeRemoveRow: (index, amount, logicalCols = [1, 2, 3]) => {},
  239. beforeRender: (isForced, skipRender) => {},
  240. beforeRenderer: (TD, row, col, prop, value, cellProperties) => {},
  241. beforeRowMove: (startRow, endRow) => {},
  242. beforeRowResize: (currentRow, newSize, isDoubleClick) => {},
  243. beforeSetRangeEnd: (coords) => {},
  244. beforeSetRangeStart: (coords) => {},
  245. beforeSetRangeStartOnly: (coords) => {},
  246. beforeStretchingColumnWidth: (stretchedWidth, column) => {},
  247. beforeTouchScroll: () => {},
  248. beforeUndo: (action) => {},
  249. beforeUnmergeCells: (cellRange, auto) => {},
  250. beforeValidate: (value, row, prop, source = 'source') => {},
  251. beforeValueRender: (value) => {},
  252. construct: () => {},
  253. hiddenColumn: (column) => {},
  254. hiddenRow: (row) => {},
  255. init: () => {},
  256. manualRowHeights: (state) => {},
  257. modifyAutofillRange: (startArea, entireArea) => {},
  258. modifyCol: (col) => {},
  259. modifyColHeader: (column) => {},
  260. modifyColumnHeaderHeight: () => {},
  261. modifyColWidth: (width) => {},
  262. modifyCopyableRange: (copyableRanges) => {},
  263. modifyData: () => {},
  264. modifyGetCellCoords: (row, column, topmost) => {},
  265. modifyRow: (row) => {},
  266. modifyRowData: (row) => {},
  267. modifyRowHeader: (row) => {},
  268. modifyRowHeight: (height, row) => {},
  269. modifyRowSourceData: (row) => {},
  270. modifyTransformEnd: (delta) => {},
  271. modifyTransformStart: (delta) => {},
  272. persistentStateLoad: () => {},
  273. persistentStateReset: () => {},
  274. persistentStateSave: () => {},
  275. skipLengthCache: (delay) => {},
  276. unmodifyCol: () => {},
  277. unmodifyRow: (row) => {},
  278. }