NgxDeebodata Input API
In the template of the component, pass your license key if deploying to any url besides http://localhost:4200. Pass a
signal object[ ] as the data input of the ngx-deebodata along with any other preferences.
Component Input API
| Input | Type | Default | Description |
|---|---|---|---|
editable |
boolean |
true |
Allows cells to be edited |
paginate |
boolean |
false |
Paginate data. Defaults to in memory |
serverSideTotal |
number |
0 |
Activate server-side pagination with a value > 0 |
pageLoadMessage |
string |
Loading... |
Message to display while you're executing server-side pagination |
rowsPerPage |
number |
25 |
Number of rows per page if paginated=true, max is 250 |
rowNumbers |
boolean |
true |
Show row numbers on left hand side of grid |
data |
signal<any[]> |
[] |
signal Array of objects to display |
color1 |
string |
"" |
Theme color 1 (css, hex, rgb) for the text color in the header, footer, and group by panels |
color2 |
string |
"" |
Theme color 2 (css, hex, rgb) for the background color in the header, footer, and group by panels |
primaryKey |
string |
"" |
primary key of your data set, helps performance to add it |
defRowHgt |
string |
50px |
default row height (px) |
defGridHgt |
number |
500 |
default grid height in px |
licenseKey |
string |
"" |
License key for non localhost deployment |
pieGraphColors |
string[] |
[] |
list of colors for pie graph sections if applicable (css, hex, rgb) |
removePieCovers |
boolean | string[]
|
false |
false removes all pie graph covers, a list of string column names removes only those columns' covers |
altRowColor |
string |
"" |
alternate row color (css, hex, rgb) |
myColumnStyles |
ColumnStyles[] |
[] |
pass css styles to specific values in a column |
myColumnValueColors |
ColumnValueColors[] |
[] |
assign a color to a value in pie, line, and bar graphs |
forceGrouping |
string[] |
[] |
array of column names to force grouping - gives dropdown filter & pie graphs for the column |
disableOmniFilter | boolean | false | True removes the top left, global filter from the DOM |
disableCharts | boolean | false | True removes the Insights button, thus disabling charts |
disableGroupBy | boolean | false | True removes the Group By drop down panel at the bottom right of the data grid |
disableExport | boolean | false | True removes the Export drop down panel at the bottom right of the data grid |
disableRowSelection | boolean | false | True removes row checkboxes, the Deselect Rows button, and the toggle Selected Rows button from the DOM |
hideJumpTo | boolean | false | True removes the jump to options in the right hand footer when the data grid is not paginate |
hideColumnFilters | boolean | false | True removes the column filters and options in the column headers |
It's best to pass hex or rgb colors to color1, color2, pieGraphColors, & altRowColor, but css colors work too
Always pass a px value to defRowHgt like '50px'
forceGrouping - if a column you want grouping/dropdown filters for isn't getting that treatment automatically,
try to force it with this - may or may not work depending on how many distinct values the column has and other criteria
removePieCovers input can be a boolean or a string[] of column names where the pie graph should be uncovered