Javascript API Reference

dataTableService.methods

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

Properties

• bgSep: string
  When two columns together have been identified as feasible for a bar graph, this is the delimiter that couples them together in a string array that also has single column names listed in it.
• columnSymbols: object (array)
  An array of objects that tells the grid which numeric columns should have symbols included in the respective cells for that column. Each object in the array should have two properties: column and symbol. You should update this in the default script before the runtime.
• comparatorOpts: object
  An object whose keys are the available data input types for the data grid (text, number, date). Each key is an array of the possible comparison types when comparing data of filters.
• currFilData: null | object (array)
  An array that mirrors the currently displayed data in the grid. It's constantly updated by your filters, sorts, and row selections.
• currMapping: object
  Object that tries to expedite figuring what is the index of a row in the mainData or unfiltered intial reference to your list of data the grid is reflecting.
• currSelRows: object (array)
  An array of the currently selected, or checked rows
• dataFilSrtTracker: null | object
  A very important object that stores all the currently applied operations to a column like it's current filter.
• defltRHgt: string
  The default height of rows. Learn more
• displayOnlySelRows: boolean
  If set to true, the grid only displays rows that are checked.
• firstCol: string
  Tells the first ordinal column on the screen
• isFiltering: boolean
  Tells the runtime if the grid is currently being filtered
• mainData: null | object (array)
  The reference to all your data that's initially loaded. It's not updated in the runtime after the grid is generated.
• mainDataLen: number
  The length of all the data. Not the currently filtered data.
• mapperWorkerId: number
  A reference to a mapping of the currently filtered data's index within the mainData. It is updated on each data grid render.
• primaryKey: string
  A true, primary key column in your data. If set, it will expedite finding a row's index in the mainData even if data is currently filtered. It helps with grid performance. Only pass this key if the column really is a primary key. This means the column has a unique value for every row.
• sortOrder: object (string array)
  Stores the order of priority of each column being sorted, if any.
• tblBot: number
  It's the boundingClientRect top of the footer of the grid.
• tblTop: number
  It's the boundingClientRect bottom of the headers of the grid.
• tblLeft: number
  The data grid's boundingClientRect left minus 200
• tblRight: number
  The data grid's boundingClientRect left plus 250
• visibleCols: object (string array)
  The list of columns currently visible on the screen. It updates on horizontal scrolls.

Functions

• getNewTrackerObj
  args: colName: string
  Gets a default object needed to track a single column's configurations at runtime. The argument is a string representing the column name.
• setTblVertBounds
  Sets the top and bottom bounds of the data grid
• setTblHorizBounds
  Sets the right and left bounds of the data grid
• setTableBounds
  Invokes setTblVertBounds and setTblHorizBounds
• elIsAboveFold
  args: el: HtmlElement, top: number
  Checks if the bottom bound of an element is greater than (below) the top bound of the data grid
• elIsBelowFold
  args: el: HtmlElement, top: number
  Checks if the top bound of an element is less than (above) the bottom bound of the data grid
• buildDataFilSrtTracker
  args: data: string array
  Accepts column names and builds a config object for each column, resulting in an object that tracks each individual column's filters, widths, etc at runtime.
• resetFilSrtTracker
  args: keepMins: boolean
  Resets the dataFilSrtTracker
• nLevelSort
  args: data: array, sortOrder: string array, obj: object
  Executes the current sort with priority
• doSortOnField
  args: field: string
  Updates needed configs for a field, the sort order, then executes the current sort with priority
• execSortOrderIndicator
  args: btn: HtmlElement, field: string, number: number
  Handles sort arrows and sort order indicators on the ui
• nLevelFilter
  args: data: array, filterVal: string, ddVals: string array, comparator: string, field: string
  Executes the current filters taking all columns into account
• columnFilter
  args: dataI: array, field: string, dataObj: object, sortOrder: string array, manual: boolean
  Updates needed configs for a field, then executes the current filters
• hasUnchkdDDVals
  args: obj: object
  Checks if a single column configuration has unchecked drop-down values, if any drop-down values exist
• easyFilter
  
• allDataFilter
  
• arefilSrtTrkPropsDefault
  Checks if all column configurations are at their default state.