{ "src\\Canvas.js": { "description": "", "methods": [ { "name": "onRows", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "onScroll", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": { "name": "any" } } ], "returns": null }, { "name": "getSubRows", "docblock": null, "modifiers": [], "params": [ { "name": "row", "type": null } ], "returns": null }, { "name": "addSubRows", "docblock": null, "modifiers": [], "params": [ { "name": "rowsInput", "type": null }, { "name": "row", "type": null }, { "name": "i", "type": null }, { "name": "displayEnd", "type": null }, { "name": "treeDepth", "type": null } ], "returns": null }, { "name": "getRows", "docblock": null, "modifiers": [], "params": [ { "name": "displayStart", "type": { "name": "number" } }, { "name": "displayEnd", "type": { "name": "number" } } ], "returns": { "type": { "name": "Array", "elements": [ { "name": "any" } ], "raw": "Array" } } }, { "name": "getScrollbarWidth", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "getScroll", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "signature", "type": "object", "raw": "{scrollTop: number; scrollLeft: number}", "signature": { "properties": [ { "key": "scrollTop", "value": { "name": "number", "required": true } }, { "key": "scrollLeft", "value": { "name": "number", "required": true } } ] } } } }, { "name": "isRowSelected", "docblock": null, "modifiers": [], "params": [ { "name": "idx", "type": null }, { "name": "row", "type": null } ], "returns": { "type": { "name": "boolean" } } }, { "name": "setScrollLeft", "docblock": null, "modifiers": [], "params": [ { "name": "scrollLeft", "type": { "name": "number" } } ], "returns": null }, { "name": "renderRow", "docblock": null, "modifiers": [], "params": [ { "name": "props", "type": { "name": "any" } } ], "returns": null }, { "name": "renderScrollingPlaceholder", "docblock": null, "modifiers": [], "params": [ { "name": "props", "type": { "name": "any" } } ], "returns": { "type": { "name": "ReactElement", "nullable": true } } }, { "name": "renderPlaceholder", "docblock": null, "modifiers": [], "params": [ { "name": "key", "type": { "name": "string" } }, { "name": "height", "type": { "name": "number" } } ], "returns": { "type": { "name": "ReactElement", "nullable": true } } } ], "props": { "rowRenderer": { "type": { "name": "union", "value": [ { "name": "func" }, { "name": "element" } ] }, "required": false, "description": "", "defaultValue": { "value": "require('./Row')", "computed": true } }, "rowHeight": { "type": { "name": "number" }, "required": true, "description": "" }, "height": { "type": { "name": "number" }, "required": true, "description": "" }, "width": { "type": { "name": "number" }, "required": false, "description": "" }, "totalWidth": { "type": { "name": "union", "value": [ { "name": "number" }, { "name": "string" } ] }, "required": false, "description": "" }, "style": { "type": { "name": "string" }, "required": false, "description": "" }, "className": { "type": { "name": "string" }, "required": false, "description": "" }, "displayStart": { "type": { "name": "number" }, "required": true, "description": "" }, "displayEnd": { "type": { "name": "number" }, "required": true, "description": "" }, "rowsCount": { "type": { "name": "number" }, "required": true, "description": "" }, "rowGetter": { "type": { "name": "union", "value": [ { "name": "func" }, { "name": "array" } ] }, "required": false, "description": "" }, "expandedRows": { "type": { "name": "array" }, "required": false, "description": "" }, "onRows": { "type": { "name": "func" }, "required": false, "description": "", "defaultValue": { "value": "() => {}", "computed": false } }, "onScroll": { "type": { "name": "func" }, "required": false, "description": "" }, "columns": { "type": { "name": "union", "value": [ { "name": "object" }, { "name": "array" } ] }, "required": true, "description": "" }, "cellMetaData": { "type": { "name": "shape", "value": "unknown" }, "required": true, "description": "" }, "selectedRows": { "type": { "name": "array" }, "required": false, "description": "", "defaultValue": { "value": "[]", "computed": false } }, "rowKey": { "type": { "name": "string" }, "required": false, "description": "" }, "rowScrollTimeout": { "type": { "name": "number" }, "required": false, "description": "", "defaultValue": { "value": "0", "computed": false } }, "contextMenu": { "type": { "name": "element" }, "required": false, "description": "" }, "getSubRowDetails": { "type": { "name": "func" }, "required": false, "description": "" }, "rowSelection": { "type": { "name": "union", "value": [ { "name": "shape", "value": { "indexes": { "name": "arrayOf", "value": { "name": "number" }, "required": true } } }, { "name": "shape", "value": { "isSelectedKey": { "name": "string", "required": true } } }, { "name": "shape", "value": { "keys": { "name": "shape", "value": { "values": { "name": "array", "required": true }, "rowKey": { "name": "string", "required": true } }, "required": true } } } ] }, "required": false, "description": "" }, "rowGroupRenderer": { "type": { "name": "func" }, "required": false, "description": "" } } }, "src\\Cell.js": { "description": "", "methods": [ { "name": "onCellClick", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": null } ], "returns": null }, { "name": "onCellContextMenu", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "onCellDoubleClick", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": null } ], "returns": null }, { "name": "onCellExpand", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": null } ], "returns": null }, { "name": "onCellKeyDown", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": null } ], "returns": null }, { "name": "onDragHandleDoubleClick", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": null } ], "returns": null }, { "name": "onDragOver", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": null } ], "returns": null }, { "name": "getStyle", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "getFormatter", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "getRowData", "docblock": null, "modifiers": [], "params": [ { "name": "props", "type": null } ], "returns": null }, { "name": "getFormatterDependencies", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "getCellClass", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "getUpdateCellClass", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "isColumnSelected", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "isSelected", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "isActive", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "isCellSelectionChanging", "docblock": null, "modifiers": [], "params": [ { "name": "nextProps", "type": { "name": "signature", "type": "object", "raw": "{ idx: number; cellMetaData: { selected: { idx: number } } }", "signature": { "properties": [ { "key": "idx", "value": { "name": "number", "required": true } }, { "key": "cellMetaData", "value": { "name": "signature", "type": "object", "raw": "{ selected: { idx: number } }", "signature": { "properties": [ { "key": "selected", "value": { "name": "signature", "type": "object", "raw": "{ idx: number }", "signature": { "properties": [ { "key": "idx", "value": { "name": "number", "required": true } } ] }, "required": true } } ] }, "required": true } } ] } } } ], "returns": { "type": { "name": "boolean" } } }, { "name": "isCellSelectEnabled", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "hasChangedDependentValues", "docblock": null, "modifiers": [], "params": [ { "name": "nextProps", "type": null } ], "returns": null }, { "name": "applyUpdateClass", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "setScrollLeft", "docblock": null, "modifiers": [], "params": [ { "name": "scrollLeft", "type": { "name": "number" } } ], "returns": null }, { "name": "isCopied", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "boolean" } } }, { "name": "isDraggedOver", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "boolean" } } }, { "name": "wasDraggedOver", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "boolean" } } }, { "name": "isDraggedCellChanging", "docblock": null, "modifiers": [], "params": [ { "name": "nextProps", "type": { "name": "any" } } ], "returns": { "type": { "name": "boolean" } } }, { "name": "isCopyCellChanging", "docblock": null, "modifiers": [], "params": [ { "name": "nextProps", "type": { "name": "any" } } ], "returns": { "type": { "name": "boolean" } } }, { "name": "isDraggedOverUpwards", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "boolean" } } }, { "name": "isDraggedOverDownwards", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "boolean" } } }, { "name": "checkFocus", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "canEdit", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "canExpand", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "createColumEventCallBack", "docblock": null, "modifiers": [], "params": [ { "name": "onColumnEvent", "type": null }, { "name": "info", "type": null } ], "returns": null }, { "name": "createCellEventCallBack", "docblock": null, "modifiers": [], "params": [ { "name": "gridEvent", "type": null }, { "name": "columnEvent", "type": null } ], "returns": null }, { "name": "createEventDTO", "docblock": null, "modifiers": [], "params": [ { "name": "gridEvents", "type": null }, { "name": "columnEvents", "type": null }, { "name": "onColumnEvent", "type": null } ], "returns": null }, { "name": "getEvents", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "renderCellContent", "docblock": null, "modifiers": [], "params": [ { "name": "props", "type": null } ], "returns": null } ], "props": { "rowIdx": { "type": { "name": "number" }, "required": true, "description": "" }, "idx": { "type": { "name": "number" }, "required": true, "description": "" }, "selected": { "type": { "name": "shape", "value": { "idx": { "name": "number", "required": true } } }, "required": false, "description": "" }, "selectedColumn": { "type": { "name": "object" }, "required": false, "description": "" }, "height": { "type": { "name": "number" }, "required": false, "description": "" }, "tabIndex": { "type": { "name": "number" }, "required": false, "description": "", "defaultValue": { "value": "-1", "computed": false } }, "ref": { "type": { "name": "string" }, "required": false, "description": "", "defaultValue": { "value": "'cell'", "computed": false } }, "column": { "type": { "name": "shape", "value": "unknown" }, "required": true, "description": "" }, "value": { "type": { "name": "union", "value": [ { "name": "string" }, { "name": "number" }, { "name": "object" }, { "name": "bool" } ] }, "required": true, "description": "" }, "isExpanded": { "type": { "name": "bool" }, "required": false, "description": "", "defaultValue": { "value": "false", "computed": false } }, "isRowSelected": { "type": { "name": "bool" }, "required": false, "description": "" }, "cellMetaData": { "type": { "name": "shape", "value": "unknown" }, "required": true, "description": "" }, "handleDragStart": { "type": { "name": "func" }, "required": false, "description": "" }, "className": { "type": { "name": "string" }, "required": false, "description": "" }, "cellControls": { "type": { "name": "any" }, "required": false, "description": "" }, "rowData": { "type": { "name": "object" }, "required": true, "description": "" }, "forceUpdate": { "type": { "name": "bool" }, "required": false, "description": "" }, "expandableOptions": { "type": { "name": "object" }, "required": true, "description": "" } } }, "src\\Draggable.js": { "description": "", "methods": [ { "name": "onMouseDown", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": { "name": "SyntheticMouseEvent", "alias": "SyntheticMouseEvent" } } ], "returns": null }, { "name": "onMouseMove", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": { "name": "SyntheticEvent", "alias": "SyntheticEvent" } } ], "returns": null }, { "name": "onMouseUp", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": { "name": "SyntheticEvent", "alias": "SyntheticEvent" } } ], "returns": null }, { "name": "cleanUp", "docblock": null, "modifiers": [], "params": [], "returns": null } ], "props": { "onDragStart": { "type": { "name": "func" }, "required": false, "description": "", "defaultValue": { "value": "() => true", "computed": false } }, "onDragEnd": { "type": { "name": "func" }, "required": false, "description": "", "defaultValue": { "value": "() => {}", "computed": false } }, "onDrag": { "type": { "name": "func" }, "required": false, "description": "", "defaultValue": { "value": "() => {}", "computed": false } }, "component": { "type": { "name": "union", "value": [ { "name": "func" }, { "name": "custom", "raw": "PropTypes.constructor" } ] }, "required": false, "description": "" } } }, "src\\Grid.js": { "description": "", "methods": [ { "name": "getStyle", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "signature", "type": "object", "raw": "{ overflow: string; outline: number; position: string; minHeight: number }", "signature": { "properties": [ { "key": "overflow", "value": { "name": "string", "required": true } }, { "key": "outline", "value": { "name": "number", "required": true } }, { "key": "position", "value": { "name": "string", "required": true } }, { "key": "minHeight", "value": { "name": "number", "required": true } } ] } } } } ], "props": { "rowGetter": { "type": { "name": "union", "value": [ { "name": "array" }, { "name": "func" } ] }, "required": true, "description": "" }, "columns": { "type": { "name": "union", "value": [ { "name": "array" }, { "name": "object" } ] }, "required": false, "description": "" }, "columnMetrics": { "type": { "name": "object" }, "required": false, "description": "" }, "minHeight": { "type": { "name": "number" }, "required": false, "description": "", "defaultValue": { "value": "350", "computed": false } }, "totalWidth": { "type": { "name": "union", "value": [ { "name": "number" }, { "name": "string" } ] }, "required": false, "description": "" }, "headerRows": { "type": { "name": "union", "value": [ { "name": "array" }, { "name": "func" } ] }, "required": false, "description": "" }, "rowHeight": { "type": { "name": "number" }, "required": false, "description": "", "defaultValue": { "value": "35", "computed": false } }, "rowRenderer": { "type": { "name": "union", "value": [ { "name": "element" }, { "name": "func" } ] }, "required": false, "description": "" }, "emptyRowsView": { "type": { "name": "func" }, "required": false, "description": "" }, "expandedRows": { "type": { "name": "union", "value": [ { "name": "array" }, { "name": "func" } ] }, "required": false, "description": "" }, "selectedRows": { "type": { "name": "union", "value": [ { "name": "array" }, { "name": "func" } ] }, "required": false, "description": "" }, "rowSelection": { "type": { "name": "union", "value": [ { "name": "shape", "value": { "indexes": { "name": "arrayOf", "value": { "name": "number" }, "required": true } } }, { "name": "shape", "value": { "isSelectedKey": { "name": "string", "required": true } } }, { "name": "shape", "value": { "keys": { "name": "shape", "value": { "values": { "name": "array", "required": true }, "rowKey": { "name": "string", "required": true } }, "required": true } } } ] }, "required": false, "description": "" }, "rowsCount": { "type": { "name": "number" }, "required": false, "description": "" }, "onRows": { "type": { "name": "func" }, "required": false, "description": "" }, "sortColumn": { "type": { "name": "string" }, "required": false, "description": "" }, "sortDirection": { "type": { "name": "enum", "value": [ { "value": "'ASC'", "computed": false }, { "value": "'DESC'", "computed": false }, { "value": "'NONE'", "computed": false } ] }, "required": false, "description": "" }, "rowOffsetHeight": { "type": { "name": "number" }, "required": true, "description": "" }, "onViewportKeydown": { "type": { "name": "func" }, "required": true, "description": "" }, "onViewportKeyup": { "type": { "name": "func" }, "required": false, "description": "" }, "onViewportDragStart": { "type": { "name": "func" }, "required": true, "description": "" }, "onViewportDragEnd": { "type": { "name": "func" }, "required": true, "description": "" }, "onViewportDoubleClick": { "type": { "name": "func" }, "required": true, "description": "" }, "onColumnResize": { "type": { "name": "func" }, "required": false, "description": "" }, "onSort": { "type": { "name": "func" }, "required": false, "description": "" }, "cellMetaData": { "type": { "name": "shape", "value": "unknown" }, "required": false, "description": "" }, "rowKey": { "type": { "name": "string" }, "required": true, "description": "" }, "rowScrollTimeout": { "type": { "name": "number" }, "required": false, "description": "" }, "contextMenu": { "type": { "name": "element" }, "required": false, "description": "" }, "getSubRowDetails": { "type": { "name": "func" }, "required": false, "description": "" }, "draggableHeaderCell": { "type": { "name": "func" }, "required": false, "description": "" }, "getValidFilterValues": { "type": { "name": "func" }, "required": false, "description": "" }, "rowGroupRenderer": { "type": { "name": "func" }, "required": false, "description": "" } } }, "src\\Header.js": { "description": "", "methods": [ { "name": "onColumnResize", "docblock": null, "modifiers": [], "params": [ { "name": "column", "type": { "name": "signature", "type": "object", "raw": "{\r\n width: number\r\n}", "signature": { "properties": [ { "key": "width", "value": { "name": "number", "required": true } } ] }, "alias": "Column" } }, { "name": "width", "type": { "name": "number" } } ], "returns": null }, { "name": "onColumnResizeEnd", "docblock": null, "modifiers": [], "params": [ { "name": "column", "type": { "name": "signature", "type": "object", "raw": "{\r\n width: number\r\n}", "signature": { "properties": [ { "key": "width", "value": { "name": "number", "required": true } } ] }, "alias": "Column" } }, { "name": "width", "type": { "name": "number" } } ], "returns": null }, { "name": "getHeaderRows", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "Array", "elements": [ { "name": "HeaderRow" } ], "raw": "Array" } } }, { "name": "getColumnMetrics", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "getColumnPosition", "docblock": null, "modifiers": [], "params": [ { "name": "column", "type": { "name": "signature", "type": "object", "raw": "{\r\n width: number\r\n}", "signature": { "properties": [ { "key": "width", "value": { "name": "number", "required": true } } ] }, "alias": "Column" } } ], "returns": { "type": { "name": "number", "nullable": true } } }, { "name": "getCombinedHeaderHeights", "docblock": null, "modifiers": [], "params": [ { "name": "until", "type": { "name": "number", "nullable": true } } ], "returns": { "type": { "name": "number" } } }, { "name": "getStyle", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "signature", "type": "object", "raw": "{position: string; height: number}", "signature": { "properties": [ { "key": "position", "value": { "name": "string", "required": true } }, { "key": "height", "value": { "name": "number", "required": true } } ] } } } }, { "name": "setScrollLeft", "docblock": null, "modifiers": [], "params": [ { "name": "scrollLeft", "type": { "name": "number" } } ], "returns": null } ], "props": { "columnMetrics": { "type": { "name": "shape", "value": { "width": { "name": "number", "required": true }, "columns": { "name": "any", "required": false } } }, "required": true, "description": "" }, "totalWidth": { "type": { "name": "union", "value": [ { "name": "number" }, { "name": "string" } ] }, "required": false, "description": "" }, "height": { "type": { "name": "number" }, "required": true, "description": "" }, "headerRows": { "type": { "name": "array" }, "required": true, "description": "" }, "sortColumn": { "type": { "name": "string" }, "required": false, "description": "" }, "sortDirection": { "type": { "name": "enum", "value": [ { "value": "'ASC'", "computed": false }, { "value": "'DESC'", "computed": false }, { "value": "'NONE'", "computed": false } ] }, "required": false, "description": "" }, "onSort": { "type": { "name": "func" }, "required": false, "description": "" }, "onColumnResize": { "type": { "name": "func" }, "required": false, "description": "" }, "onScroll": { "type": { "name": "func" }, "required": false, "description": "" }, "draggableHeaderCell": { "type": { "name": "func" }, "required": false, "description": "" }, "getValidFilterValues": { "type": { "name": "func" }, "required": false, "description": "" } } }, "src\\HeaderCell.js": { "description": "", "methods": [ { "name": "onDragStart", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": { "name": "SyntheticMouseEvent", "alias": "SyntheticMouseEvent" } } ], "returns": null }, { "name": "onDrag", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": { "name": "SyntheticMouseEvent", "alias": "SyntheticMouseEvent" } } ], "returns": null }, { "name": "onDragEnd", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": { "name": "SyntheticMouseEvent", "alias": "SyntheticMouseEvent" } } ], "returns": null }, { "name": "getWidthFromMouseEvent", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": { "name": "SyntheticMouseEvent", "alias": "SyntheticMouseEvent" } } ], "returns": { "type": { "name": "number" } } }, { "name": "getCell", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "ReactComponent" } } }, { "name": "getStyle", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "signature", "type": "object", "raw": "{width:number; left: number; display: string; position: string; overflow: string; height: number; margin: number; textOverflow: string; whiteSpace: string }", "signature": { "properties": [ { "key": "width", "value": { "name": "number", "required": true } }, { "key": "left", "value": { "name": "number", "required": true } }, { "key": "display", "value": { "name": "string", "required": true } }, { "key": "position", "value": { "name": "string", "required": true } }, { "key": "overflow", "value": { "name": "string", "required": true } }, { "key": "height", "value": { "name": "number", "required": true } }, { "key": "margin", "value": { "name": "number", "required": true } }, { "key": "textOverflow", "value": { "name": "string", "required": true } }, { "key": "whiteSpace", "value": { "name": "string", "required": true } } ] } } } }, { "name": "setScrollLeft", "docblock": null, "modifiers": [], "params": [ { "name": "scrollLeft", "type": { "name": "number" } } ], "returns": null } ], "props": { "renderer": { "type": { "name": "union", "value": [ { "name": "func" }, { "name": "element" } ] }, "required": true, "description": "", "defaultValue": { "value": "function simpleCellRenderer(objArgs: {column: {name: string}}): ReactElement {\r\n return
{objArgs.column.name}
;\r\n}", "computed": false } }, "column": { "type": { "name": "shape", "value": "unknown" }, "required": true, "description": "" }, "onResize": { "type": { "name": "func" }, "required": true, "description": "" }, "height": { "type": { "name": "number" }, "required": true, "description": "" }, "onResizeEnd": { "type": { "name": "func" }, "required": true, "description": "" }, "className": { "type": { "name": "string" }, "required": false, "description": "" } } }, "src\\HeaderRow.js": { "description": "", "methods": [ { "name": "getHeaderCellType", "docblock": null, "modifiers": [], "params": [ { "name": "column", "type": null } ], "returns": null }, { "name": "getFilterableHeaderCell", "docblock": null, "modifiers": [], "params": [ { "name": "column", "type": null } ], "returns": null }, { "name": "getSortableHeaderCell", "docblock": null, "modifiers": [], "params": [ { "name": "column", "type": null } ], "returns": null }, { "name": "getHeaderRenderer", "docblock": null, "modifiers": [], "params": [ { "name": "column", "type": null } ], "returns": null }, { "name": "getStyle", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "unknown" } } }, { "name": "getCells", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "Array", "elements": [ { "name": "unknown" } ], "raw": "Array" } } }, { "name": "setScrollLeft", "docblock": null, "modifiers": [], "params": [ { "name": "scrollLeft", "type": { "name": "number" } } ], "returns": null } ], "props": { "width": { "type": { "name": "union", "value": [ { "name": "number" }, { "name": "string" } ] }, "required": false, "description": "" }, "height": { "type": { "name": "number" }, "required": true, "description": "" }, "columns": { "type": { "name": "union", "value": [ { "name": "array" }, { "name": "object" } ] }, "required": false, "description": "" }, "onColumnResize": { "type": { "name": "func" }, "required": false, "description": "" }, "onSort": { "type": { "name": "func" }, "required": true, "description": "" }, "onColumnResizeEnd": { "type": { "name": "func" }, "required": false, "description": "" }, "style": { "type": { "name": "shape", "value": { "overflow": { "name": "string", "required": false }, "width": { "name": "union", "value": [ { "name": "number" }, { "name": "string" } ], "required": false }, "height": { "name": "number", "required": false }, "position": { "name": "string", "required": false } } }, "required": false, "description": "" }, "sortColumn": { "type": { "name": "string" }, "required": false, "description": "" }, "sortDirection": { "type": { "name": "enum", "computed": true, "value": "DEFINE_SORT" }, "required": false, "description": "" }, "cellRenderer": { "type": { "name": "func" }, "required": false, "description": "" }, "headerCellRenderer": { "type": { "name": "func" }, "required": false, "description": "" }, "filterable": { "type": { "name": "bool" }, "required": false, "description": "" }, "onFilterChange": { "type": { "name": "func" }, "required": false, "description": "" }, "resizing": { "type": { "name": "object" }, "required": false, "description": "" }, "onScroll": { "type": { "name": "func" }, "required": false, "description": "" }, "rowType": { "type": { "name": "string" }, "required": false, "description": "" }, "draggableHeaderCell": { "type": { "name": "func" }, "required": false, "description": "" } } }, "src\\ReactDataGrid.js": { "description": "", "methods": [ { "name": "hasSelectedCellChanged", "docblock": null, "modifiers": [], "params": [ { "name": "selected", "type": { "name": "signature", "type": "object", "raw": "{\r\n rowIdx: number;\r\n idx: number;\r\n}", "signature": { "properties": [ { "key": "rowIdx", "value": { "name": "number", "required": true } }, { "key": "idx", "value": { "name": "number", "required": true } } ] }, "alias": "SelectedType" } } ], "returns": null }, { "name": "onContextMenuHide", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "onColumnEvent", "docblock": null, "modifiers": [], "params": [ { "name": "ev", "type": { "name": "SyntheticEvent", "alias": "SyntheticEvent" } }, { "name": "columnEvent", "type": { "name": "signature", "type": "object", "raw": "{\r\n name: string,\r\n rowIdx: number;\r\n idx: number;\r\n}", "signature": { "properties": [ { "key": "name", "value": { "name": "string", "required": true } }, { "key": "rowIdx", "value": { "name": "number", "required": true } }, { "key": "idx", "value": { "name": "number", "required": true } } ] }, "alias": "ColumnEvent" } } ], "returns": null }, { "name": "onSelect", "docblock": null, "modifiers": [], "params": [ { "name": "selected", "type": { "name": "signature", "type": "object", "raw": "{\r\n rowIdx: number;\r\n idx: number;\r\n}", "signature": { "properties": [ { "key": "rowIdx", "value": { "name": "number", "required": true } }, { "key": "idx", "value": { "name": "number", "required": true } } ] }, "alias": "SelectedType" } } ], "returns": null }, { "name": "onCellClick", "docblock": null, "modifiers": [], "params": [ { "name": "cell", "type": { "name": "signature", "type": "object", "raw": "{\r\n rowIdx: number;\r\n idx: number;\r\n}", "signature": { "properties": [ { "key": "rowIdx", "value": { "name": "number", "required": true } }, { "key": "idx", "value": { "name": "number", "required": true } } ] }, "alias": "SelectedType" } } ], "returns": null }, { "name": "onCellContextMenu", "docblock": null, "modifiers": [], "params": [ { "name": "cell", "type": { "name": "signature", "type": "object", "raw": "{\r\n rowIdx: number;\r\n idx: number;\r\n}", "signature": { "properties": [ { "key": "rowIdx", "value": { "name": "number", "required": true } }, { "key": "idx", "value": { "name": "number", "required": true } } ] }, "alias": "SelectedType" } } ], "returns": null }, { "name": "onCellDoubleClick", "docblock": null, "modifiers": [], "params": [ { "name": "cell", "type": { "name": "signature", "type": "object", "raw": "{\r\n rowIdx: number;\r\n idx: number;\r\n}", "signature": { "properties": [ { "key": "rowIdx", "value": { "name": "number", "required": true } }, { "key": "idx", "value": { "name": "number", "required": true } } ] }, "alias": "SelectedType" } } ], "returns": null }, { "name": "onViewportDoubleClick", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "onPressArrowUp", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": { "name": "SyntheticEvent", "alias": "SyntheticEvent" } } ], "returns": null }, { "name": "onPressArrowDown", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": { "name": "SyntheticEvent", "alias": "SyntheticEvent" } } ], "returns": null }, { "name": "onPressArrowLeft", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": { "name": "SyntheticEvent", "alias": "SyntheticEvent" } } ], "returns": null }, { "name": "onPressArrowRight", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": { "name": "SyntheticEvent", "alias": "SyntheticEvent" } } ], "returns": null }, { "name": "onPressTab", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": { "name": "SyntheticEvent", "alias": "SyntheticEvent" } } ], "returns": null }, { "name": "onPressEnter", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": { "name": "SyntheticKeyboardEvent", "alias": "SyntheticKeyboardEvent" } } ], "returns": null }, { "name": "onPressDelete", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": { "name": "SyntheticKeyboardEvent", "alias": "SyntheticKeyboardEvent" } } ], "returns": null }, { "name": "onPressEscape", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": { "name": "SyntheticKeyboardEvent", "alias": "SyntheticKeyboardEvent" } } ], "returns": null }, { "name": "onPressBackspace", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": { "name": "SyntheticKeyboardEvent", "alias": "SyntheticKeyboardEvent" } } ], "returns": null }, { "name": "onPressChar", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": { "name": "SyntheticKeyboardEvent", "alias": "SyntheticKeyboardEvent" } } ], "returns": null }, { "name": "onPressKeyWithCtrl", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": { "name": "SyntheticKeyboardEvent", "alias": "SyntheticKeyboardEvent" } } ], "returns": null }, { "name": "onGridRowsUpdated", "docblock": null, "modifiers": [], "params": [ { "name": "cellKey", "type": null }, { "name": "fromRow", "type": null }, { "name": "toRow", "type": null }, { "name": "updated", "type": null }, { "name": "action", "type": null } ], "returns": null }, { "name": "onCellCommit", "docblock": null, "modifiers": [], "params": [ { "name": "commit", "type": { "name": "signature", "type": "object", "raw": "{\r\n keyCode: string;\r\n changed: {expandedHeight: number};\r\n rowIdx: number;\r\n}", "signature": { "properties": [ { "key": "keyCode", "value": { "name": "string", "required": true } }, { "key": "changed", "value": { "name": "signature", "type": "object", "raw": "{expandedHeight: number}", "signature": { "properties": [ { "key": "expandedHeight", "value": { "name": "number", "required": true } } ] }, "required": true } }, { "key": "rowIdx", "value": { "name": "number", "required": true } } ] }, "alias": "RowUpdateEvent" } } ], "returns": null }, { "name": "onDragStart", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": { "name": "SyntheticEvent", "alias": "SyntheticEvent" } } ], "returns": null }, { "name": "onToggleFilter", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "onDragHandleDoubleClick", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": null } ], "returns": null }, { "name": "onCellExpand", "docblock": null, "modifiers": [], "params": [ { "name": "args", "type": null } ], "returns": null }, { "name": "onRowExpandToggle", "docblock": null, "modifiers": [], "params": [ { "name": "args", "type": null } ], "returns": null }, { "name": "handleDragStart", "docblock": null, "modifiers": [], "params": [ { "name": "dragged", "type": { "name": "signature", "type": "object", "raw": "{\r\n idx: number;\r\n rowIdx: number;\r\n value: string;\r\n}", "signature": { "properties": [ { "key": "idx", "value": { "name": "number", "required": true } }, { "key": "rowIdx", "value": { "name": "number", "required": true } }, { "key": "value", "value": { "name": "string", "required": true } } ] }, "alias": "DraggedType" } } ], "returns": null }, { "name": "handleDragEnd", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "handleDragEnter", "docblock": null, "modifiers": [], "params": [ { "name": "row", "type": { "name": "any" } } ], "returns": null }, { "name": "handleTerminateDrag", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "handlePaste", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "handleCopy", "docblock": null, "modifiers": [], "params": [ { "name": "args", "type": { "name": "signature", "type": "object", "raw": "{value: string}", "signature": { "properties": [ { "key": "value", "value": { "name": "string", "required": true } } ] } } } ], "returns": null }, { "name": "handleSort", "docblock": null, "modifiers": [], "params": [ { "name": "columnKey", "type": { "name": "string" } }, { "name": "direction", "type": { "name": "SortType", "alias": "SortType" } } ], "returns": null }, { "name": "getSelectedRow", "docblock": null, "modifiers": [], "params": [ { "name": "rows", "type": null }, { "name": "key", "type": null } ], "returns": null }, { "name": "useNewRowSelection", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "handleShiftSelect", "docblock": null, "modifiers": [], "params": [ { "name": "rowIdx", "type": null } ], "returns": null }, { "name": "handleNewRowSelect", "docblock": null, "modifiers": [], "params": [ { "name": "rowIdx", "type": null }, { "name": "rowData", "type": null } ], "returns": null }, { "name": "handleRowSelect", "docblock": null, "modifiers": [], "params": [ { "name": "rowIdx", "type": { "name": "number" } }, { "name": "columnKey", "type": { "name": "string" } }, { "name": "rowData", "type": null }, { "name": "e", "type": { "name": "Event", "alias": "Event" } } ], "returns": null }, { "name": "handleCheckboxChange", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": { "name": "SyntheticEvent", "alias": "SyntheticEvent" } } ], "returns": null }, { "name": "getScrollOffSet", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "getRowOffsetHeight", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "number" } } }, { "name": "getHeaderRows", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "Array", "elements": [ { "name": "signature", "type": "object", "raw": "{ref: string; height: number;}", "signature": { "properties": [ { "key": "ref", "value": { "name": "string", "required": true } }, { "key": "height", "value": { "name": "number", "required": true } } ] } } ], "raw": "Array<{ref: string; height: number;}>" } } }, { "name": "getInitialSelectedRows", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "getRowSelectionProps", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "getSelectedRows", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "getSelectedValue", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "string" } } }, { "name": "moveSelectedCell", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": { "name": "SyntheticEvent", "alias": "SyntheticEvent" } }, { "name": "rowDelta", "type": { "name": "number" } }, { "name": "cellDelta", "type": { "name": "number" } } ], "returns": null }, { "name": "getNbrColumns", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "calculateNextSelectionPosition", "docblock": null, "modifiers": [], "params": [ { "name": "cellNavigationMode", "type": { "name": "string" } }, { "name": "cellDelta", "type": { "name": "number" } }, { "name": "rowDelta", "type": { "name": "number" } } ], "returns": null }, { "name": "isAtLastCellInRow", "docblock": null, "modifiers": [], "params": [ { "name": "nbrColumns", "type": null } ], "returns": null }, { "name": "isAtLastRow", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "isAtFirstCellInRow", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "isAtFirstRow", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "openCellEditor", "docblock": null, "modifiers": [], "params": [ { "name": "rowIdx", "type": null }, { "name": "idx", "type": null } ], "returns": null }, { "name": "scrollToColumn", "docblock": null, "modifiers": [], "params": [ { "name": "colIdx", "type": null } ], "returns": null }, { "name": "setActive", "docblock": null, "modifiers": [], "params": [ { "name": "keyPressed", "type": { "name": "string" } } ], "returns": null }, { "name": "setInactive", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "isActive", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "boolean" } } }, { "name": "setupGridColumns", "docblock": null, "modifiers": [], "params": [ { "name": "props", "type": null } ], "returns": { "type": { "name": "Array", "elements": [ { "name": "any" } ], "raw": "Array" } } }, { "name": "copyPasteEnabled", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "boolean" } } }, { "name": "dragEnabled", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "boolean" } } }, { "name": "renderToolbar", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "ReactElement" } } } ], "props": { "rowHeight": { "type": { "name": "number" }, "required": true, "description": "", "defaultValue": { "value": "35", "computed": false } }, "headerRowHeight": { "type": { "name": "number" }, "required": false, "description": "" }, "minHeight": { "type": { "name": "number" }, "required": true, "description": "", "defaultValue": { "value": "350", "computed": false } }, "minWidth": { "type": { "name": "number" }, "required": false, "description": "" }, "enableRowSelect": { "type": { "name": "union", "value": [ { "name": "bool" }, { "name": "string" } ] }, "required": false, "description": "", "defaultValue": { "value": "false", "computed": false } }, "onRowUpdated": { "type": { "name": "func" }, "required": false, "description": "" }, "rowGetter": { "type": { "name": "func" }, "required": true, "description": "" }, "rowsCount": { "type": { "name": "number" }, "required": true, "description": "" }, "toolbar": { "type": { "name": "element" }, "required": false, "description": "" }, "enableCellSelect": { "type": { "name": "bool" }, "required": false, "description": "", "defaultValue": { "value": "false", "computed": false } }, "columns": { "type": { "name": "union", "value": [ { "name": "object" }, { "name": "array" } ] }, "required": true, "description": "" }, "onFilter": { "type": { "name": "func" }, "required": false, "description": "" }, "onCellCopyPaste": { "type": { "name": "func" }, "required": false, "description": "" }, "onCellsDragged": { "type": { "name": "func" }, "required": false, "description": "" }, "onAddFilter": { "type": { "name": "func" }, "required": false, "description": "" }, "onGridSort": { "type": { "name": "func" }, "required": false, "description": "" }, "onDragHandleDoubleClick": { "type": { "name": "func" }, "required": false, "description": "" }, "onGridRowsUpdated": { "type": { "name": "func" }, "required": false, "description": "" }, "onRowSelect": { "type": { "name": "func" }, "required": false, "description": "" }, "rowKey": { "type": { "name": "string" }, "required": false, "description": "", "defaultValue": { "value": "'id'", "computed": false } }, "rowScrollTimeout": { "type": { "name": "number" }, "required": false, "description": "", "defaultValue": { "value": "0", "computed": false } }, "onClearFilters": { "type": { "name": "func" }, "required": false, "description": "" }, "contextMenu": { "type": { "name": "element" }, "required": false, "description": "" }, "cellNavigationMode": { "type": { "name": "enum", "value": [ { "value": "'none'", "computed": false }, { "value": "'loopOverRow'", "computed": false }, { "value": "'changeRow'", "computed": false } ] }, "required": false, "description": "", "defaultValue": { "value": "'none'", "computed": false } }, "onCellSelected": { "type": { "name": "func" }, "required": false, "description": "" }, "onCellDeSelected": { "type": { "name": "func" }, "required": false, "description": "" }, "onCellExpand": { "type": { "name": "func" }, "required": false, "description": "" }, "enableDragAndDrop": { "type": { "name": "bool" }, "required": false, "description": "" }, "onRowExpandToggle": { "type": { "name": "func" }, "required": false, "description": "" }, "draggableHeaderCell": { "type": { "name": "func" }, "required": false, "description": "" }, "getValidFilterValues": { "type": { "name": "func" }, "required": false, "description": "" }, "rowSelection": { "type": { "name": "shape", "value": { "enableShiftSelect": { "name": "bool", "required": false }, "onRowsSelected": { "name": "func", "required": false }, "onRowsDeselected": { "name": "func", "required": false }, "showCheckbox": { "name": "bool", "required": false }, "selectBy": { "name": "union", "value": [ { "name": "shape", "value": { "indexes": { "name": "arrayOf", "value": { "name": "number" }, "required": true } } }, { "name": "shape", "value": { "isSelectedKey": { "name": "string", "required": true } } }, { "name": "shape", "value": { "keys": { "name": "shape", "value": { "values": { "name": "array", "required": true }, "rowKey": { "name": "string", "required": true } }, "required": true } } } ], "required": true } } }, "required": false, "description": "" }, "onRowClick": { "type": { "name": "func" }, "required": false, "description": "" }, "onGridKeyUp": { "type": { "name": "func" }, "required": false, "description": "" }, "onGridKeyDown": { "type": { "name": "func" }, "required": false, "description": "" }, "rowGroupRenderer": { "type": { "name": "func" }, "required": false, "description": "" }, "rowActionsCell": { "type": { "name": "func" }, "required": false, "description": "" }, "tabIndex": { "defaultValue": { "value": "-1", "computed": false } } } }, "src\\ResizeHandle.js": { "description": "", "methods": [] }, "src\\Row.js": { "description": "", "methods": [ { "name": "handleDragEnter", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "getSelectedColumn", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "getCellRenderer", "docblock": null, "modifiers": [], "params": [ { "name": "columnKey", "type": null } ], "returns": null }, { "name": "getCells", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "Array", "elements": [ { "name": "ReactElement" } ], "raw": "Array" } } }, { "name": "getRowHeight", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "number" } } }, { "name": "getCellValue", "docblock": null, "modifiers": [], "params": [ { "name": "key", "type": { "name": "union", "raw": "number | string", "elements": [ { "name": "number" }, { "name": "string" } ] } } ], "returns": { "type": { "name": "any" } } }, { "name": "setScrollLeft", "docblock": null, "modifiers": [], "params": [ { "name": "scrollLeft", "type": { "name": "number" } } ], "returns": null }, { "name": "doesRowContainSelectedCell", "docblock": null, "modifiers": [], "params": [ { "name": "props", "type": { "name": "any" } } ], "returns": { "type": { "name": "boolean" } } }, { "name": "isContextMenuDisplayed", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "willRowBeDraggedOver", "docblock": null, "modifiers": [], "params": [ { "name": "props", "type": { "name": "any" } } ], "returns": { "type": { "name": "boolean" } } }, { "name": "hasRowBeenCopied", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "boolean" } } }, { "name": "getExpandableOptions", "docblock": null, "modifiers": [], "params": [ { "name": "columnKey", "type": null } ], "returns": null }, { "name": "renderCell", "docblock": null, "modifiers": [], "params": [ { "name": "props", "type": { "name": "any" } } ], "returns": { "type": { "name": "ReactElement" } } } ], "props": { "height": { "type": { "name": "number" }, "required": true, "description": "", "defaultValue": { "value": "35", "computed": false } }, "columns": { "type": { "name": "union", "value": [ { "name": "object" }, { "name": "array" } ] }, "required": true, "description": "" }, "row": { "type": { "name": "any" }, "required": true, "description": "" }, "cellRenderer": { "type": { "name": "func" }, "required": false, "description": "", "defaultValue": { "value": "require('./Cell')", "computed": true } }, "cellMetaData": { "type": { "name": "shape", "value": "unknown" }, "required": false, "description": "" }, "isSelected": { "type": { "name": "bool" }, "required": false, "description": "", "defaultValue": { "value": "false", "computed": false } }, "idx": { "type": { "name": "number" }, "required": true, "description": "" }, "expandedRows": { "type": { "name": "arrayOf", "value": { "name": "object" } }, "required": false, "description": "" }, "extraClasses": { "type": { "name": "string" }, "required": false, "description": "" }, "forceUpdate": { "type": { "name": "bool" }, "required": false, "description": "" }, "subRowDetails": { "type": { "name": "object" }, "required": false, "description": "" }, "isRowHovered": { "type": { "name": "bool" }, "required": false, "description": "" } } }, "src\\RowGroup.js": { "description": "", "methods": [ { "name": "isSelected", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "onClick", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": null } ], "returns": null }, { "name": "onKeyDown", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": null } ], "returns": null }, { "name": "onRowExpandClick", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "onRowExpandToggle", "docblock": null, "modifiers": [], "params": [ { "name": "expand", "type": null } ], "returns": null }, { "name": "getClassName", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "checkFocus", "docblock": null, "modifiers": [], "params": [], "returns": null } ], "props": { "name": { "type": { "name": "string" }, "required": true, "description": "" }, "columnGroupName": { "type": { "name": "string" }, "required": true, "description": "" }, "isExpanded": { "type": { "name": "bool" }, "required": true, "description": "" }, "treeDepth": { "type": { "name": "number" }, "required": true, "description": "" }, "height": { "type": { "name": "number" }, "required": true, "description": "" }, "cellMetaData": { "type": { "name": "object" }, "required": false, "description": "" }, "idx": { "type": { "name": "number" }, "required": true, "description": "" }, "renderer": { "type": { "name": "func" }, "required": false, "description": "", "defaultValue": { "value": "(props) => {\r\n let treeDepth = props.treeDepth || 0;\r\n let marginLeft = treeDepth * 20;\r\n\r\n return (\r\n
\r\n {props.isExpanded ? String.fromCharCode('9660') : String.fromCharCode('9658')}\r\n {props.columnGroupName} : {props.name}\r\n
);\r\n}", "computed": false } } } }, "src\\Viewport.js": { "description": "", "methods": [ { "name": "onScroll", "docblock": null, "modifiers": [], "params": [ { "name": "scroll", "type": { "name": "signature", "type": "object", "raw": "{scrollTop: number; scrollLeft: number}", "signature": { "properties": [ { "key": "scrollTop", "value": { "name": "number", "required": true } }, { "key": "scrollLeft", "value": { "name": "number", "required": true } } ] } } } ], "returns": null }, { "name": "getScroll", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "signature", "type": "object", "raw": "{scrollLeft: number; scrollTop: number}", "signature": { "properties": [ { "key": "scrollLeft", "value": { "name": "number", "required": true } }, { "key": "scrollTop", "value": { "name": "number", "required": true } } ] } } } }, { "name": "setScrollLeft", "docblock": null, "modifiers": [], "params": [ { "name": "scrollLeft", "type": { "name": "number" } } ], "returns": null } ], "props": { "rowOffsetHeight": { "type": { "name": "number" }, "required": true, "description": "" }, "totalWidth": { "type": { "name": "union", "value": [ { "name": "number" }, { "name": "string" } ] }, "required": true, "description": "" }, "columnMetrics": { "type": { "name": "object" }, "required": true, "description": "" }, "rowGetter": { "type": { "name": "union", "value": [ { "name": "array" }, { "name": "func" } ] }, "required": true, "description": "" }, "selectedRows": { "type": { "name": "array" }, "required": false, "description": "" }, "rowSelection": { "type": { "name": "union", "value": [ { "name": "shape", "value": { "indexes": { "name": "arrayOf", "value": { "name": "number" }, "required": true } } }, { "name": "shape", "value": { "isSelectedKey": { "name": "string", "required": true } } }, { "name": "shape", "value": { "keys": { "name": "shape", "value": { "values": { "name": "array", "required": true }, "rowKey": { "name": "string", "required": true } }, "required": true } } } ] }, "required": false, "description": "" }, "expandedRows": { "type": { "name": "array" }, "required": false, "description": "" }, "rowRenderer": { "type": { "name": "union", "value": [ { "name": "element" }, { "name": "func" } ] }, "required": false, "description": "" }, "rowsCount": { "type": { "name": "number" }, "required": true, "description": "" }, "rowHeight": { "type": { "name": "number" }, "required": true, "description": "" }, "onRows": { "type": { "name": "func" }, "required": false, "description": "" }, "onScroll": { "type": { "name": "func" }, "required": false, "description": "" }, "minHeight": { "type": { "name": "number" }, "required": false, "description": "" }, "cellMetaData": { "type": { "name": "shape", "value": "unknown" }, "required": false, "description": "" }, "rowKey": { "type": { "name": "string" }, "required": true, "description": "" }, "rowScrollTimeout": { "type": { "name": "number" }, "required": false, "description": "" }, "contextMenu": { "type": { "name": "element" }, "required": false, "description": "" }, "getSubRowDetails": { "type": { "name": "func" }, "required": false, "description": "" }, "rowGroupRenderer": { "type": { "name": "func" }, "required": false, "description": "" } } }, "src\\addons\\cells\\headerCells\\FilterableHeaderCell.js": { "description": "", "methods": [ { "name": "handleChange", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": { "name": "Event", "alias": "Event" } } ], "returns": null }, { "name": "renderInput", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "ReactElement", "nullable": true } } } ], "props": { "onChange": { "type": { "name": "func" }, "required": true, "description": "" }, "column": { "type": { "name": "shape", "value": "unknown" }, "required": false, "description": "" } } }, "src\\addons\\cells\\headerCells\\SortableHeaderCell.js": { "description": "", "methods": [ { "name": "onClick", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "getSortByText", "docblock": null, "modifiers": [], "params": [], "returns": null } ], "props": { "columnKey": { "type": { "name": "string" }, "required": true, "description": "" }, "column": { "type": { "name": "shape", "value": { "name": { "name": "node", "required": false } } }, "required": false, "description": "" }, "onSort": { "type": { "name": "func" }, "required": true, "description": "" }, "sortDirection": { "type": { "name": "enum", "value": [ { "value": "'ASC'", "computed": false }, { "value": "'DESC'", "computed": false }, { "value": "'NONE'", "computed": false } ] }, "required": false, "description": "" } } }, "src\\addons\\cells\\headerCells\\filters\\AutoCompleteFilter.js": { "description": "", "methods": [ { "name": "getOptions", "docblock": null, "modifiers": [], "params": [ { "name": "newProps", "type": null } ], "returns": null }, { "name": "columnValueContainsSearchTerms", "docblock": null, "modifiers": [], "params": [ { "name": "columnValue", "type": null }, { "name": "filterTerms", "type": null } ], "returns": null }, { "name": "filterValues", "docblock": null, "modifiers": [], "params": [ { "name": "row", "type": null }, { "name": "columnFilter", "type": null }, { "name": "columnKey", "type": null } ], "returns": null }, { "name": "handleChange", "docblock": null, "modifiers": [], "params": [ { "name": "value", "type": null } ], "returns": null } ], "props": { "onChange": { "type": { "name": "func" }, "required": true, "description": "" }, "column": { "type": { "name": "shape", "value": "unknown" }, "required": false, "description": "" }, "getValidFilterValues": { "type": { "name": "func" }, "required": false, "description": "" } } }, "src\\addons\\cells\\headerCells\\filters\\NumericFilter.js": { "description": "", "methods": [ { "name": "attachTooltip", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "filterValues", "docblock": null, "modifiers": [], "params": [ { "name": "row", "type": null }, { "name": "columnFilter", "type": null }, { "name": "columnKey", "type": null } ], "returns": null }, { "name": "getRules", "docblock": null, "modifiers": [], "params": [ { "name": "value", "type": null } ], "returns": null }, { "name": "handleKeyPress", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": null } ], "returns": null }, { "name": "handleChange", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": null } ], "returns": null } ], "props": { "onChange": { "type": { "name": "func" }, "required": true, "description": "" }, "column": { "type": { "name": "shape", "value": "unknown" }, "required": false, "description": "" } } }, "src\\addons\\editors\\AutoCompleteEditor.js": { "description": "", "methods": [ { "name": "handleChange", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "getValue", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "any" } } }, { "name": "getEditorDisplayValue", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "getInputNode", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "getLabel", "docblock": null, "modifiers": [], "params": [ { "name": "item", "type": { "name": "any" } } ], "returns": { "type": { "name": "string" } } }, { "name": "hasResults", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "boolean" } } }, { "name": "isFocusedOnSuggestion", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "boolean" } } }, { "name": "constuctValueFromParams", "docblock": null, "modifiers": [], "params": [ { "name": "obj", "type": { "name": "any" } }, { "name": "props", "type": { "name": "Array", "elements": [ { "name": "string" } ], "raw": "Array", "nullable": true } } ], "returns": { "type": { "name": "string" } } } ], "props": { "onCommit": { "type": { "name": "func" }, "required": false, "description": "" }, "options": { "type": { "name": "arrayOf", "value": { "name": "custom", "raw": "optionPropType" } }, "required": false, "description": "" }, "label": { "type": { "name": "any" }, "required": false, "description": "" }, "value": { "type": { "name": "any" }, "required": false, "description": "" }, "height": { "type": { "name": "number" }, "required": false, "description": "" }, "valueParams": { "type": { "name": "arrayOf", "value": { "name": "string" } }, "required": false, "description": "" }, "column": { "type": { "name": "shape", "value": "unknown" }, "required": false, "description": "" }, "resultIdentifier": { "type": { "name": "string" }, "required": false, "description": "", "defaultValue": { "value": "'id'", "computed": false } }, "search": { "type": { "name": "string" }, "required": false, "description": "" }, "onKeyDown": { "type": { "name": "func" }, "required": false, "description": "" }, "onFocus": { "type": { "name": "func" }, "required": false, "description": "" }, "editorDisplayValue": { "type": { "name": "func" }, "required": false, "description": "" } } }, "src\\addons\\editors\\AutoCompleteTokensEditor.js": { "description": "", "methods": [ { "name": "getInputNode", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "getValue", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "handleSelectChange", "docblock": null, "modifiers": [], "params": [ { "name": "value", "type": null } ], "returns": null } ], "props": { "options": { "type": { "name": "array" }, "required": true, "description": "" }, "column": { "type": { "name": "shape", "value": { "name": { "name": "string", "required": true }, "key": { "name": "string", "required": true }, "width": { "name": "number", "required": true }, "filterable": { "name": "bool", "required": false } } }, "required": false, "description": "" }, "value": { "type": { "name": "array" }, "required": false, "description": "" } } }, "src\\addons\\editors\\CheckboxEditor.js": { "description": "", "methods": [ { "name": "handleChange", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": { "name": "Event", "alias": "Event" } } ], "returns": null } ], "props": { "value": { "type": { "name": "bool" }, "required": false, "description": "" }, "rowIdx": { "type": { "name": "number" }, "required": false, "description": "" }, "column": { "type": { "name": "shape", "value": { "key": { "name": "string", "required": false }, "onCellChange": { "name": "func", "required": false } } }, "required": false, "description": "" }, "dependentValues": { "type": { "name": "object" }, "required": false, "description": "" } } }, "src\\addons\\editors\\DateRangeEditor.js": { "description": "", "methods": [ { "name": "isDateValid", "docblock": null, "modifiers": [], "params": [ { "name": "date", "type": { "name": "Date", "alias": "Date" } } ], "returns": { "type": { "name": "boolean" } } }, { "name": "validate", "docblock": null, "modifiers": [], "params": [ { "name": "value", "type": { "name": "signature", "type": "object", "raw": "{ startDate: Date; endDate: Date}", "signature": { "properties": [ { "key": "startDate", "value": { "name": "Date", "required": true } }, { "key": "endDate", "value": { "name": "Date", "required": true } } ] }, "alias": "DateRangeValue" } } ], "returns": { "type": { "name": "boolean" } } }, { "name": "handleDateFilterApply", "docblock": null, "modifiers": [], "params": [ { "name": "startDate", "type": { "name": "string" } }, { "name": "endDate", "type": { "name": "string" } } ], "returns": null } ], "props": { "format": { "type": { "name": "string" }, "required": false, "description": "", "defaultValue": { "value": "'YYYY-MM-DD'", "computed": false } }, "ranges": { "type": { "name": "arrayOf", "value": { "name": "string" } }, "required": false, "description": "", "defaultValue": { "value": "[]", "computed": false } }, "value": { "type": { "name": "shape", "value": { "startDate": { "name": "custom", "raw": "React.PropTypes.Date.isRequired", "required": true }, "endDate": { "name": "custom", "raw": "React.PropTypes.Date.isRequired", "required": true } } }, "required": true, "description": "" } } }, "src\\addons\\editors\\DropDownEditor.js": { "description": "", "methods": [ { "name": "getInputNode", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "onClick", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "onDoubleClick", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "renderOptions", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "Array", "elements": [ { "name": "ReactElement" } ], "raw": "Array" } } } ], "props": { "options": { "type": { "name": "arrayOf", "value": { "name": "union", "value": [ { "name": "string" }, { "name": "custom", "raw": "React.PropTypes.objectOf({\r\n id: React.PropTypes.string,\r\n title: React.PropTypes.string,\r\n value: React.PropTypes.string,\r\n text: React.PropTypes.string\r\n})" } ] } }, "required": true, "description": "" } } }, "src\\addons\\editors\\EditorBase.js": { "description": "", "methods": [ { "name": "getStyle", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "signature", "type": "object", "raw": "{width: string}", "signature": { "properties": [ { "key": "width", "value": { "name": "string", "required": true } } ] } } } }, { "name": "getValue", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "any" } } }, { "name": "getInputNode", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "inheritContainerStyles", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "boolean" } } } ], "props": { "onKeyDown": { "type": { "name": "func" }, "required": true, "description": "" }, "value": { "type": { "name": "any" }, "required": true, "description": "" }, "onBlur": { "type": { "name": "func" }, "required": true, "description": "" }, "column": { "type": { "name": "shape", "value": "unknown" }, "required": true, "description": "" }, "commit": { "type": { "name": "func" }, "required": true, "description": "" } } }, "src\\addons\\editors\\EditorContainer.js": { "description": "", "methods": [ { "name": "createEditor", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "ReactElement" } } }, { "name": "onPressEnter", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "onPressTab", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "onPressEscape", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": { "name": "SyntheticKeyboardEvent", "alias": "SyntheticKeyboardEvent" } } ], "returns": null }, { "name": "onPressArrowDown", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": { "name": "SyntheticKeyboardEvent", "alias": "SyntheticKeyboardEvent" } } ], "returns": null }, { "name": "onPressArrowUp", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": { "name": "SyntheticKeyboardEvent", "alias": "SyntheticKeyboardEvent" } } ], "returns": null }, { "name": "onPressArrowLeft", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": { "name": "SyntheticKeyboardEvent", "alias": "SyntheticKeyboardEvent" } } ], "returns": null }, { "name": "onPressArrowRight", "docblock": null, "modifiers": [], "params": [ { "name": "e", "type": { "name": "SyntheticKeyboardEvent", "alias": "SyntheticKeyboardEvent" } } ], "returns": null }, { "name": "editorHasResults", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "boolean" } } }, { "name": "editorIsSelectOpen", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "getRowMetaData", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "any", "nullable": true } } }, { "name": "getEditor", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "Editor" } } }, { "name": "getInputNode", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "HTMLInputElement" } } }, { "name": "getInitialValue", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "string" } } }, { "name": "getContainerClass", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "commit", "docblock": null, "modifiers": [], "params": [ { "name": "args", "type": { "name": "signature", "type": "object", "raw": "{key : string}", "signature": { "properties": [ { "key": "key", "value": { "name": "string", "required": true } } ] } } } ], "returns": null }, { "name": "isNewValueValid", "docblock": null, "modifiers": [], "params": [ { "name": "value", "type": { "name": "string" } } ], "returns": { "type": { "name": "boolean" } } }, { "name": "setCaretAtEndOfInput", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "isCaretAtBeginningOfInput", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "boolean" } } }, { "name": "isCaretAtEndOfInput", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "boolean" } } }, { "name": "setTextInputFocus", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "hasEscapeBeenPressed", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "renderStatusIcon", "docblock": null, "modifiers": [], "params": [], "returns": { "type": { "name": "ReactElement", "nullable": true } } } ], "props": { "rowIdx": { "type": { "name": "number" }, "required": false, "description": "" }, "rowData": { "type": { "name": "object" }, "required": true, "description": "" }, "value": { "type": { "name": "union", "value": [ { "name": "string" }, { "name": "number" }, { "name": "object" }, { "name": "bool" } ] }, "required": true, "description": "" }, "cellMetaData": { "type": { "name": "shape", "value": { "selected": { "name": "object", "required": true }, "copied": { "name": "object", "required": false }, "dragged": { "name": "object", "required": false }, "onCellClick": { "name": "func", "required": false }, "onCellDoubleClick": { "name": "func", "required": false }, "onCommitCancel": { "name": "func", "required": false }, "onCommit": { "name": "func", "required": false } } }, "required": true, "description": "" }, "column": { "type": { "name": "object" }, "required": true, "description": "" }, "height": { "type": { "name": "number" }, "required": true, "description": "" } } }, "src\\addons\\editors\\SimpleTextEditor.js": { "description": "", "methods": [] }, "src\\addons\\editors\\widgets\\DateRangeFilter.js": { "description": "", "methods": [ { "name": "handleApply", "docblock": null, "modifiers": [], "params": [ { "name": "ev", "type": null }, { "name": "picker", "type": null } ], "returns": null }, { "name": "handleClear", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "getTitle", "docblock": null, "modifiers": [], "params": [], "returns": null } ], "props": { "format": { "type": { "name": "string" }, "required": true, "description": "" }, "ranges": { "type": { "name": "object" }, "required": true, "description": "" }, "onApply": { "type": { "name": "func" }, "required": false, "description": "" }, "title": { "type": { "name": "string" }, "required": true, "description": "" }, "onblur": { "type": { "name": "func" }, "required": false, "description": "" }, "startDate": { "type": { "name": "custom", "raw": "validateDate" }, "required": false, "description": "" }, "endDate": { "type": { "name": "custom", "raw": "validateDate" }, "required": false, "description": "" } } }, "src\\addons\\formatters\\DateRangeFormatter.js": { "description": "", "methods": [ { "name": "formatDate", "docblock": null, "modifiers": [], "params": [ { "name": "date", "type": { "name": "union", "raw": "Date | moment", "elements": [ { "name": "Date" }, { "name": "moment" } ] } } ], "returns": { "type": { "name": "string" } } } ], "props": { "value": { "type": { "name": "shape", "value": { "startDate": { "name": "union", "value": [ { "name": "string" }, { "name": "object" } ], "required": false }, "endDate": { "name": "union", "value": [ { "name": "string" }, { "name": "object" } ], "required": false } } }, "required": true, "description": "", "defaultValue": { "value": "{startDate: null, endDate: null}", "computed": false } }, "inputFormat": { "type": { "name": "string" }, "required": false, "description": "", "defaultValue": { "value": "'YYYY-MM-DD'", "computed": false } }, "displayFormat": { "type": { "name": "string" }, "required": false, "description": "", "defaultValue": { "value": "'YYYY-MM-DD'", "computed": false } } } }, "src\\addons\\formatters\\DropDownFormatter.js": { "description": "", "methods": [], "props": { "options": { "type": { "name": "arrayOf", "value": { "name": "union", "value": [ { "name": "string" }, { "name": "custom", "raw": "React.PropTypes.objectOf({\r\n id: React.PropTypes.string,\r\n title: React.PropTypes.string,\r\n value: React.PropTypes.string,\r\n text: React.PropTypes.string\r\n})" } ] } }, "required": true, "description": "" }, "value": { "type": { "name": "string" }, "required": true, "description": "" } } }, "src\\addons\\formatters\\ImageFormatter.js": { "description": "", "methods": [ { "name": "_load", "docblock": null, "modifiers": [], "params": [ { "name": "src", "type": null } ], "returns": null }, { "name": "_onLoad", "docblock": null, "modifiers": [], "params": [ { "name": "src", "type": null } ], "returns": null } ], "props": { "value": { "type": { "name": "string" }, "required": true, "description": "" } } }, "src\\addons\\formatters\\SimpleCellFormatter.js": { "description": "", "methods": [], "props": { "value": { "type": { "name": "union", "value": [ { "name": "string" }, { "name": "number" }, { "name": "object" }, { "name": "bool" } ] }, "required": true, "description": "" } } }, "src\\addons\\menu\\ContextMenu.js": { "description": "", "methods": [], "props": { "children": { "type": { "name": "node" }, "required": false, "description": "" } } }, "src\\addons\\menu\\MenuHeader.js": { "description": "", "methods": [], "props": { "children": { "type": { "name": "any" }, "required": false, "description": "" } } }, "src\\addons\\toolbars\\AdvancedToolbar.js": { "description": "", "methods": [], "props": { "children": { "type": { "name": "array" }, "required": false, "description": "" }, "enableAddRow": { "defaultValue": { "value": "true", "computed": false } } } }, "src\\addons\\toolbars\\GroupedColumnButton.js": { "description": "", "methods": [], "props": { "name": { "type": { "name": "object" }, "required": true, "description": "" }, "onColumnGroupDeleted": { "type": { "name": "func" }, "required": false, "description": "" } } }, "src\\addons\\toolbars\\Toolbar.js": { "description": "", "methods": [ { "name": "onAddRow", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "renderAddRowButton", "docblock": null, "modifiers": [], "params": [], "returns": null }, { "name": "renderToggleFilterButton", "docblock": null, "modifiers": [], "params": [], "returns": null } ], "props": { "onAddRow": { "type": { "name": "func" }, "required": false, "description": "" }, "onToggleFilter": { "type": { "name": "func" }, "required": false, "description": "" }, "enableFilter": { "type": { "name": "bool" }, "required": false, "description": "" }, "numberOfRows": { "type": { "name": "number" }, "required": false, "description": "" }, "addRowButtonText": { "type": { "name": "string" }, "required": false, "description": "", "defaultValue": { "value": "'Add Row'", "computed": false } }, "filterRowsButtonText": { "type": { "name": "string" }, "required": false, "description": "", "defaultValue": { "value": "'Filter Rows'", "computed": false } }, "enableAddRow": { "defaultValue": { "value": "true", "computed": false } } } } }