Javascript API Reference

deebo.methods

The deebo api is a plain JavaScript object with 1 property: methods. Methods is a self-invoking function that returns various properties and functions that can be referenced from deebo.methods on the top-level of the Window object. After loading the enterprise script, you reference the deebo API in your own scripts like: deebo.methods.someProperty or deebo.methods.someFunction

Properties

• useColWid: string | null
  A default width for columns that can be overridden
• deboTotal: string
  A static property name that helps with building pie graphs. You shouldn't need to alter this.
• dTblHeight: number
  The height of the data grid, which can be updated using click and drag on the grid footer.
• desRowHeight: string
  
• mouseEventBreak: number
  The window width at which the data grid runtime will listen for processing mouse events that handle column, row, and grid resizing.
• uniSep: string
  A delimiter to replace spaces in column names when they're being used as as part of html attribute values like id or class.
• verticalRest: number
  The current scrollTop of the data grid.
• horizRest: number
  The current scrollLeft of the data grid.
• aboveHgt: number
  The height of the element above the visible grid that helps with row virtualization.
• belowHgt: number
  The height of the element below the visible grid that helps with row virtualization.
• useRowWid: string
  The width of a row.
• rowNumbers: boolean
  Determines whether or not to display row numbers. Learn more
• lastElRowIndex: number
  The index of the last row of currently filtered data.
• listenToCellDraggerMouseMove: boolean
  Tells the script to process a mouse event.
• currColumnEdit: string | null
  The column that the currently edited cell belongs to.
• linkCell: string (css selector) | null
  
• linkCells: object (string array)
  
• columnNames: object (string array)
  All the column names.
• showCharts: boolean
  Controls if charts should be displaying
• currEditCol: string
  
• currEditIndex: number
  The index of the currently edited cell in the mainData. Not the currently filtered data.
• uProvidedPrimKey: string | null
  A primary key you can pass to help with the cell edit hook
• editable: boolean
  Set to allow or disable cell editing
• waitingInsightGraphs: object
  Tells which charts to wait to load until the chart container scrolls to the tippy top of them, optimizing performance.
• badStrings: object (string array)
  
• statOpts: object (string array)
  The list of stat options to display bar graph data for
• isMultiFiltering: boolean
  A signal about filtering that will defer processing events if currently true
• tblFooterListenersAdded: boolean
  
• scrollDir: string ("up" | "down")
  Whether the scroll event on the data grid was down or up.
• filterBuildUp: object (string array)
  Possible filter events to process after a wait.
• workerUrl: string
  The url of the web worker you can use to enhance performance.
• numCols: object (string array)
  Columns whose values are all numbers (or null)
• maxBarWid: number
  The max width of bar graph bars.
• initListenersAdded: boolean
  Signals if important listeners for buttons in the top control menu have been added

Functions

• getAllColsAtRuntime
  args: excludeDuid: boolean, excludeHidden: boolean
  Get all the columns in the grid or all the ones that aren't hidden
• setMaxCols
  
  args: wid: number
  Sets a reasonable max amount of columns that should be visible in the view. Normally passed window.innerWidth as the "wid" arg
• getAllColWidth
  args: colLen: number
  Gets the summed width of all columns
• freezeColOnClick
  args: event
  Freezes the first column so it's position is fixed even if the grid is scrolled horizontally
• removeAllFreezeCols
  Unfreezes the first column and any other possibly frozen columns
• setColHeaderHgt
  Sets column headers to a uniform height based on the tallest one
• renameColSpecChars
  args: data: object (array)
  Helps with managing column names from your data
• scoopOutObjsInObjs
  args: data: object (array)
  Goes one level deep into your array of objects if any of your individual object properties are objects themselves. Then it scoops those object properties out into the top level of your array of objects since we don't support nested data visually within the grid itself.
• convertNeededCols
  args: data: object (array)
  Performs data type coercion where appropriate. An extremely important function that takes your data and converts any columns that are strings, but should be something more operable, like numbers or dates, into just that. So let's say you have data like [ {name: "Tim", age: "32"}, {name: "Jane", age: "27"} ]. Technically the age column would be strings by default since they have quotes, but we convert it to numbers so filters, sorts, and charts work like one would expect.
• createSelectRowCheck
  args: indx: number
  Creates the checkbox for each row of data taking in the index
• setRowSelChecksPlacement
  Places row checks in the proper place vertically within the row
• setRowNumbers
  Sets the row numbers
• initCheckTop
  
• handleKeyCheckRowSelect
  
• toggleNonInitCtrlBtns
  
• handleFilSDataStr
  
• toggleSelectedRows
  
• toggleSingleRowSelected
  
• forceFreeze
  
• toggleSelRowButtons
  
• setBtnTogRows
  
• clearSelectedRows
  
• updateUiColCellTheme
  
• handleSingleColResize
  
• testHideMinBtn
  
• clearAllFocused
  
• blockEventsInCells
  
• unbindMouseRemoveEvts
  
• setLastRowIndex
  
• dblClickCol
  
• setLoading
  
• buildInitUiDataTable
  
• getPrimaryKey
  
• setIdealColWidth
  
• handleColAnyDDFilters
  
• swapColFilterToSelect
  
• buildSelFilOptions
  
• handleMultiSelFilter
  
• killSelFilOpts
  
• testEditDDs
  
• setCellToEdit
  
• cellEditNeedsVal
  
• handleValidatedCellEditFocus
  
• clearFCellDragger
  
• clearDCellFcsd
  
• clearValidatedEdit
  
• execValClear
  
• handleDraggerMU
  
• clearCellDEdits
  
• clearDragEditFlag
  
• handleCellDraggerInit
  
• focusCellDragger
  
• settleCellDragger
  
• handleCellDraggerEdit
  
• getRawNum
  
• createValEditInput
  
• stopWinSel
  
• emitEdit
  
• execCellEdit
  
• checkCellEditOnClick
  
• handleTheme
  
• setUpPaginatorOnTblLoad
  
• figureFilterType
  
• insertSelectComparator
  
• insertSelectComparatorBtn
  
• handleComparatorChange
  
• blurContEd
  
• setColsOnVisScreen
  
• handleScrlBarDrag
  
• handleScroll
  
• execHorizScroll
  
• execVertScroll
  
• handleScrollEnd
  
• shouldValidateEdit
  
• addCell
  
• updateCell
  
• execHorizBodyScroll
  
• cleanUpPossibles
  
• execVertScrollDown
  
• execVertScrollUp
  
• getRowsWithContentVert
  
• clearAboveFoldRows
  
• clearBelowFoldRows
  
• setDataRowWidthsOnMinimize
  
• titleCase
  
• insertColumnHeader
  
• getDataColumns
  
• saveTheme
  
• idCol
  
• mapLongDate
  
• mapTxtMonths
  
• testShortDate
  
• testISODate
  
• testLongDate
  
• coerceDate
  
• isADateObject
  
• stripSpecChars
  
• doBigData
  
• mystartsWith
  
• isEnterKey
  
• dontSan
  
• sanitizeUi
  
• getRgbParts
  
• componentToHex
  
• rgbToHex
  
• hexToRgb
  
• figureCellText
  
• processCellLinks
  
• setRowHgtOnImgLoad
  
• setSingleRowHgt
  
• replaceUniSep
  
• doSortOnClick
  
• resetColFilter
  
• clickAllBtnFilXs
  
• filterOnKeyUp
  
• resetTblBody
  
• renderCurrData
  
• resetCurrentData
  
• getMiniColCount
  
• getColFrmClsList
  
• minimizeColumn
  
• setHoldingCheckCls
  
• addToHiddenCols
  
• clearHiddenCols
  
• clearSortInds
  
• styleEmptyFilDataRow
  
• findObjIndxInData
  
• setExportCount
  
• toggleExportOpts
  
• closeExportOpts
  
• handleExportData
  
• downloadFileExp
  
• whipToDelimForm
  
• displaySelectedInsights
  
• toggleTopControls
  
• clearSelInsights
  
• keepSelInsightsOnRows
  
• makeCloseSelInsightsBtn
  
• getCurrentInsightData
  
• monitorInsightScrl
  
• getDataInsights
  
• getColumnValueCounts
  
• getColumnMode
  
• buildBarGraphWithTwoCols
  
• buildBGBars
  
• buildYAxisBGVals
  
• calcCurrChangeOverTime
  
• findDataMedian
  
• getNumColumnValueCounts
  
• findDataMode
  
• handleStatChange
  
• barGLblMouseIn
  
• barGLblMouseOut
  
• cleanUpPieLayovers
  
• buildPieGraphFromColVals
  
• showNumColValDist
  
• topIsInView
  
• buildLineGraphs
  
• buildLg
  
• handleLgValSelChange
  
• findTimeDiffOpts
  
• updateTimeIntvl
  
• setUseableLgData
  
• sizeUpBgDims
  
• enableLgBtns
  
• drawLineGraph
  
• drawCanvasLineGraph
  
• matchVdBarToStat
  
• killAllVdHighlights
  
• showDotPlotInfo
  
• hideDotPlotInfo
  
• killAllSelLgBtns
  
• mapCompToSym
  
• getAllFilSrtInfo
  
• initListeners
  Super important function that runs on the DOMContentLoaded event. It tries to attach necessary event listeners to buttons and inputs along the top controls. If you are loading the data grid script on the fly in your own script, you should call this function because the DOMContentLoaded event executes once when the page loads so the script added afterwards won't pick up the event.