Methods
(computed) btnSize() → {string}
Returns the size of the button based on the screen size.
- Source:
Returns:
The size of the button ('sm' for small or 'md' for medium).
- Type
- string
(computed) filterSet() → {boolean}
Returns a boolean value indicating whether the filter is set for any column.
- Source:
Returns:
True if the filter is set for any column, otherwise false.
- Type
- boolean
(computed) hasRowToolbar() → {boolean}
Determines if the row toolbar should be displayed. The toolbar is shown if any of the following conditions are met:
- Editing is allowed (
allowEditis true) - Deleting is allowed (
allowDeleteis true) - There are specific row actions defined (
rowActionsis true) - The user has admin privileges (
isAdminis true)
- Source:
Returns:
True if the row toolbar should be displayed, otherwise false.
- Type
- boolean
(computed) height() → {number}
Calculates the height of the table component.
- Source:
Returns:
The calculated height of the table.
- Type
- number
(computed) nRows() → {number}
Returns the number of rows in the table. If the rows array is empty, it returns 0. If the filterSet is enabled, it returns the length of the filtered rows array. Otherwise, it returns the length of the rows array.
- Source:
Returns:
The number of rows in the table.
- Type
- number
(computed) rowToolbarWidth()
- Source:
(computed) tableStyle() → {string}
Returns the style for the table.
- Source:
Returns:
The style for the table.
- Type
- string
(function) data()
- Source:
(method) calc(col, summary)
Calculate the summary of a column
Parameters:
| Name | Type | Description |
|---|---|---|
col |
object | column |
summary |
object |
- Source:
(method) calculateColumnWidths()
- Source:
(method) cancel()
- Source:
(method) contextValueChanged()
- Source:
(method) editPdf()
- Source:
(async, function) onPopupClosed()
- Source:
(method) getApiAndOptions()
- Source:
(method) getHasPdfReport()
- Source:
(method) getPdfReportRow()
- Source:
(method) handleKeyDown(event, isParent)
Handles the keydown event.
Parameters:
| Name | Type | Description |
|---|---|---|
event |
Event | The keydown event object. |
isParent |
boolean | Indicates whether the event is triggered by a parent component. |
- Source:
(method) moveTo()
- Source:
(method) previewPdf()
- Source:
(method) realValue(col, val) → {any}
Converts the given value based on the column type.
Parameters:
| Name | Type | Description |
|---|---|---|
col |
Object | The column object. |
val |
any | The value to be converted. |
- Source:
Returns:
- The converted value.
- Type
- any
(method) save()
- Source:
(method) saveChanges()
- Source:
(method) saveForm()
- Source:
(method) scroll(details)
Scroll event
Parameters:
| Name | Type | Description |
|---|---|---|
details |
* |
- Source:
(method) selectedRowsLabel()
Text displaying the number of selected rows
- Source:
(method) undoChanges()
- Source:
(watcher) "$route.query.timestamp"()
- Source:
(function) handler()
- Source:
(function) data()
- Source:
(method) calcWidth(type) → {string}
Calculates the width of a column based on its type.
Parameters:
| Name | Type | Description |
|---|---|---|
type |
string | The type of the column. |
- Source:
Returns:
The width of the column.
- Type
- string
(method) chart()
- Source:
(method) createContentForExport(exportRows, columns) → {string}
Creates content for export based on the provided export rows and columns.
Parameters:
| Name | Type | Description |
|---|---|---|
exportRows |
Array | The rows to be exported. |
columns |
Array | The columns to be exported. |
- Source:
Returns:
The content for export.
- Type
- string
(method) deleteInStore(row) → {void}
Deletes a row from the array in store, if necessary.
Parameters:
| Name | Type | Description |
|---|---|---|
row |
Object | The row to be deleted. |
- Source:
Returns:
- Type
- void
(method) exportTable()
Exports the tableAPI to a CSV file.
- Source:
(method) init()
Initializes the tableAPI component.
- Source:
(method) replaceVariables(obj, rowToPass)
Replaces moustache variables in an object with corresponding values from row.
Parameters:
| Name | Type | Description |
|---|---|---|
obj |
Object | The object containing variables to be replaced. |
rowToPass |
Object | The object containing values to replace the variables. |
- Source:
(method) runRowAction(action, row)
Runs a row action.
Parameters:
| Name | Type | Description |
|---|---|---|
action |
Object | Action to be run. |
row |
Object | The row to be acted upon. |
- Source:
(method) runTableAction(action)
Runs a tableAPI action (custom function).
Parameters:
| Name | Type | Description |
|---|---|---|
action |
Object | Action to be run. |
- Source:
(method) showRowInfo(row)
Shows the row info in a popup.
Parameters:
| Name | Type | Description |
|---|---|---|
row |
Object | The row to show info for. |
- Source:
(method) wrapCsvValue(val, formatFn, row) → {string}
Wraps a value in a CSV cell.
Parameters:
| Name | Type | Description |
|---|---|---|
val |
* | The value to be wrapped. |
formatFn |
* | The function to format the value. |
row |
* | The row containing the value. |
- Source:
Returns:
The wrapped value.
- Type
- string