Members
(constant) EXPORT_FORMAT :Object
Type:
- Object
(constant) OPTIONS :Object
Maps server side field types to alpaca field types options
Type:
- Object
Methods
_getRowFilterColumns(settings, colNames) → {Array}
Returns columns that have row filter defined
Parameters:
| Name | Type | Description |
|---|---|---|
settings |
||
colNames |
Returns:
- Type
- Array
_hasParentRow($currentRow) → {*}
Returns parent row unique id if current has a parent row
Parameters:
| Name | Type | Description |
|---|---|---|
$currentRow |
Returns:
- Type
- *
aaplyGroupHeader()
Add Group Header
Returns:
void
addToClassicationField()
This Method: addToClassicationField will be called from library structure table to triggers a formfield selectize to add a new classification
Returns:
Triggers a formfield selectize to add a new classification
applyTableColumWidth()
Apply user specific width customization on table each column
Returns:
void
copyValueToClipboard()
Utility module for performing clipboard related operations. Utility functions can be accessed using singleton class "App.clipboard"
createFormTemplateService() → {Object}
Factory method to create form template service.
Returns:
object containing API methods of this class
- Type
- Object
decorateConfig(searchForm)
Adds autocomplete settings to fields in the search form config
Parameters:
| Name | Type | Description |
|---|---|---|
searchForm |
displaySuccessMessage()
Utility methods for create dataset and filter
since 2023.1.0
drillDownSearchResult(data)
Perform drilldown on search results when clicking on chart
Example
App.Chart.drillDownSearchResult(data);Parameters:
| Name | Type | Description |
|---|---|---|
data |
editClassification(objectId, sourceWidgetId, customOptions)
Opens form widget from datatable column to edit the classification field
Parameters:
| Name | Type | Description |
|---|---|---|
objectId |
||
sourceWidgetId |
||
customOptions |
Returns:
dashboard with Form and tablewidgets to edit the classification field
editClassificationOnSuccess(objectId, data)
Render toast message and closes the modal on success
Parameters:
| Name | Type | Description |
|---|---|---|
objectId |
||
data |
Returns:
render toast message and closes the modal
editClassificationPostRender()
This method is the postprocess method configured on classification form. Classification form is a 1 of the 2 widgets(i.e Classification str and classification form) on the dashboard. In this post processor, the tablewidget is updated with event. where, when a row is selected from str table, that row will be polulated in form field.
Returns:
registers the onclick handlers for table rows.
getExportPayload(dataTable, type) → {Object}
Generates and returns JSON object having data for export
Parameters:
| Name | Type | Description |
|---|---|---|
dataTable |
instance of the table which is being exported |
|
type |
EXPORT_FORMAT | export format |
Returns:
export payload
- Type
- Object
getFormContent(dataTable, type) → {DocumentFragment}
Builds form content for POST submit.
Parameters:
| Name | Type | Description |
|---|---|---|
dataTable |
instance of the table which is being exported |
|
type |
EXPORT_FORMAT | export format |
Returns:
- Type
- DocumentFragment
getModal()
templates for modal and filed for dataset and filter
since 2023.1.0
getPath(section, field) → {string}
Parameters:
| Name | Type | Description |
|---|---|---|
section |
||
field |
Returns:
- Type
- string
getValue(value, visibleValue) → {Object}
Parameters:
| Name | Type | Description |
|---|---|---|
value |
||
visibleValue |
Returns:
- Type
- Object
handleServiceWorkerUpdate(action, payload, error)
Handles messages received from Service Worker. These are usually delayed.
Parameters:
| Name | Type | Description |
|---|---|---|
action |
||
payload |
||
error |
hide(dataTableWidget)
Hides empty box in the widget. Generally invoked when a table has data
Parameters:
| Name | Type | Description |
|---|---|---|
dataTableWidget |
App.dataTable.DataTable | instance |
highlightContent($container, value, optionsopt, DataTable)
Highlights matched content based on value
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
$container |
jQuery | jquery element defining the scope for toggling highlight |
|
value |
string | value to be highlighted |
|
options |
object |
<optional> |
options to be passed to the API |
DataTable |
object |
highlightElement($element)
Highlights the passed in element with yellow blink
Parameters:
| Name | Type | Description |
|---|---|---|
$element |
jQuery | jquery element that will be highlighted |
highlightRow($element)
Highlights the passed in element with light green
Parameters:
| Name | Type | Description |
|---|---|---|
$element |
jQuery | jquery element that will be highlighted |
invokeSubsServiceCall(dataOptions, data, event, method)
Invokes OOTB service call depending on event and data
Parameters:
| Name | Type | Description |
|---|---|---|
dataOptions |
data options for service url defined in the command to override default service url |
|
data |
data generated based on selection to pass as body to service call |
|
event |
event name (subscribe/unSubscribe/editSubscription) |
|
method |
method to be used while making service call |
isAny(fieldType) → {boolean}
Parameters:
| Name | Type | Description |
|---|---|---|
fieldType |
Returns:
- Type
- boolean
isAutocomplete(fieldType) → {boolean}
Parameters:
| Name | Type | Description |
|---|---|---|
fieldType |
Returns:
- Type
- boolean
isCheckbox(fieldType) → {boolean}
Parameters:
| Name | Type | Description |
|---|---|---|
fieldType |
Returns:
- Type
- boolean
isConnectMultiple(fieldType) → {boolean}
Parameters:
| Name | Type | Description |
|---|---|---|
fieldType |
Returns:
- Type
- boolean
isGroupHeader() → {boolean}
Check whether a table column has group header or not.
Returns:
- Type
- boolean
isHeliumSelect(fieldType) → {boolean}
Parameters:
| Name | Type | Description |
|---|---|---|
fieldType |
Returns:
- Type
- boolean
isMarkdown(fieldType) → {boolean}
Parameters:
| Name | Type | Description |
|---|---|---|
fieldType |
Returns:
- Type
- boolean
isMultiValue(field) → {boolean}
Check whether a field e.i attribute is a multi value at the schema level
Parameters:
| Name | Type | Description |
|---|---|---|
field |
Returns:
- Type
- boolean
isRadioButton(fieldType) → {boolean}
Parameters:
| Name | Type | Description |
|---|---|---|
fieldType |
Returns:
- Type
- boolean
isRichtext(fieldType) → {boolean}
Parameters:
| Name | Type | Description |
|---|---|---|
fieldType |
Returns:
- Type
- boolean
isSelect(fieldType) → {boolean}
Parameters:
| Name | Type | Description |
|---|---|---|
fieldType |
Returns:
- Type
- boolean
isSingleConnect(fieldType) → {boolean}
Parameters:
| Name | Type | Description |
|---|---|---|
fieldType |
Returns:
- Type
- boolean
isTextArea(fieldType) → {boolean}
Parameters:
| Name | Type | Description |
|---|---|---|
fieldType |
Returns:
- Type
- boolean
openCommentsInSidePanel(input, objectId)
Opens the dashboard passed in input.options.dashboardRef in sidepanel
Parameters:
| Name | Type | Description |
|---|---|---|
input |
inout | configuration parameters for dashboard |
objectId |
context object id to be set in sidepanel |
removeExistingPanel()
utils Function to remove existing panels if any before loading new panel from view collection's toolbar
show(dataTableWidget)
Shows an empty box in the widget with a message indicating there's no data
Parameters:
| Name | Type | Description |
|---|---|---|
dataTableWidget |
App.dataTable.DataTable | instance |
submitExport(dataTable, type)
Builds data based on data table and submits to server for export
Parameters:
| Name | Type | Description |
|---|---|---|
dataTable |
||
type |
subscribe(configData)
Makes a OOTB service call to subscribe selected objects
Parameters:
| Name | Type | Description |
|---|---|---|
configData |
data options defined in the command along with dataTable information |
toggleContentHighlight($container, value)
Removes highlighting of content from container and marks new content based on passed in value
Parameters:
| Name | Type | Description |
|---|---|---|
$container |
jQuery | jquery element defining the scope for toggling highlight |
value |
string | value to be highlighted |
unHighlightContent($container, optionsopt)
Remove highlighting of all content within the container
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
$container |
jQuery | jquery element defining the scope for toggling highlight |
|
options |
object |
<optional> |
options to be passed to the API |
unHighlightRow($element)
Highlights the passed in element with light green
Parameters:
| Name | Type | Description |
|---|---|---|
$element |
jQuery | jquery element that will be highlighted |
unSubscribe(configData)
Makes a OOTB service call to unSubscribe selected objects
Parameters:
| Name | Type | Description |
|---|---|---|
configData |
data options defined in the command along with dataTable information |
updateClassification(payload)
Updates the selected classifications to busObject
Parameters:
| Name | Type | Description |
|---|---|---|
payload |
Returns:
promise object
validateOptions() → {boolean}
Validates if the options are correctly configured.
Returns:
True if options is correctly configured, otherwise false.
- Type
- boolean