API Reference
The following is a list of JavaScript API provided in Profound UI. For your convenience, the API are grouped by categories.
- Commonly Used API
- Element-related API
- attachCalendar( id, format )
- changeElementClass( id, customClass )
- createNamedElement( type, name )
- getCursorPosition( input element )
- getElementValue( id, autocompUseValueField )
- getInnerText( object or id )
- hideElement( id )
- hideElements( id1, id2, id3, etc... )
- newElement( row, col, type, content, id )
- pui.detachCalendar(object or id)
- pui.errorTip(widget, message, hideDelay)
- pui.expandAccordionSection( id, section )
- pui.fieldExit( minus )
- pui.getRuntimeContainerHeight()
- pui.gotoNextElement(currentElement)
- pui.gotoPreviousElement(currentElement)
- pui.shiftElements( start point, end point, move by )
- pui.showCalendar( object or id )
- removeElement( id )
- removeElements( id1, id2, id3, etc… )
- setDOMAttribute(element, attribute, value )
- setTab( tabPanelid, tab )
- pui.getRadioGroupValue( fieldName )
- Genie-specific API
- deAbbreviate( id, from array, to array )
- detectScreen( id1, value1, id2, value2, etc. )
- find( search string )
- getAllFields()
- getCol( id or object )
- getInputFields()
- getLeft( element )
- getOutputFields()
- getRight( element )
- getRow( id or object )
- getWindowObj( element id, window object )
- massMove( parameters )
- moveElement( id, row, col )
- multiStepAction( step1, step2, etc. )
- positionCursorToFirstElement()
- pui.disconnectJob(callback)
- pui.rebuildSubfileMenu( choices, values )
- saveScreenImage()
- showAsWindow()
- stopShowingAsWindow()
- pui.getScreenJSON()
- Atrium-specific API
- Atrium.activateTab( tab )
- Atrium.attachActivityMonitor()
- Atrium.breakMessageFormat( message, stringwrapper )
- Atrium.closeAllTabs( keepHome )
- Atrium.closeTab( tab )
- Atrium.dimensions
- Atrium.getAtriumWindow()
- Atrium.getCurrentTab()
- Atrium.getUser()
- Atrium.launchItem( itemId, closable, callback )
- Atrium.launchItem( launchObject )
- Atrium.launchURL( url, title )
- Atrium.promptCloseTab
- Atrium.promptCloseBrowser
- Atrium.refreshNavPanel()
- Atrium.resetInactivityTimeout()
- Atrium.runPCCommand( command )
- Atrium.onload()
- Atrium.onlaunch( launchObject )
- Atrium pui.language
- Atrium.setMenuFilter()
- Atrium.setTabTitle()
- Atrium brkmsg handler
- Atrium.onclose()
- Combo Box Methods
- Grid Methods
- setFilter( columnIndex, expression )
- getAllDataValues( applyFilter )
- isRowSelected( row )
- scrollToRow( row )
- exportXLSX( file )
- setCursorRecordNumber(rrn)
- getFilter( columnIndex )
- expandTreeLevel( rrn )
- isColumnHidden( columnid )
- setProperty( property, value )
- clearHighlighting()
- show()
- toggleTreeLevel( rrn )
- clearState(part)
- expand()
- deselectRow( row )
- getColumnIdFromFieldName( fieldName )
- rowZoom( rowNumber )
- getDataValue( row, fieldName )
- refresh()
- getColumnIndexFromFieldName( fieldName )
- toggle()
- hideColumn( columnIndex )
- isRowFilteredOut( row )
- showRow( rrn )
- hideRow( rrn )
- startFilter( columnIndex )
- getSelectedCount()
- setNumberOfRows( rows )
- collapseTreeLevel( rrn )
- getRRN( row )
- hide()
- removeColumn( columnIndex )
- setDataValue(rowNum, fieldName, value)
- removeAllFilters()
- find( columnIndex, text, next )
- getRowNumber( rrn )
- showColumn( columnIndex )
- exportCSV( file )
- getSelectedRows()
- selectRow( row, append )
- removeFilter( columnIndex )
- collapse()
- render()
- getCellValue( row, col )
- startFind( columnIndex )
- getRecordCount()
- File Upload Methods
- Tab Panel Methods
- AJAX Development
- PC Integration API
- String Manipulation API
- System Information API
- Event-related API
- Widget Development API
- Miscellaneous API
- postTo( url, parm1, value1, parm2, value2, etc. )
- postToNewWindow( url, parm1, value1 , parm2, value2, etc… )
- setCursor( coordinates or id )
- pui.addUrlCacheBuster()
- pui.applyResponse( data, response )
- pui.breakMessageFormat( message, stringwrapper )
- pui.buildFKeyMenu( config )
- pui.captureData()
- pui.closeSession()
- pui.download( config )
- pui.downloadURL(config)
- pui.focusOnContainer()
- pui.getActiveContainer()
- pui.getAllScreenProps()
- pui.getDimensions( container )
- pui.getDisplayType()
- pui.getScreenProp()
- pui.getWindowSize()
- pui.isServerBusy()
- pui.keepAlive()
- pui.maskScreen()
- pui.newUUID()
- pui.openURL( url )
- pui.refresh()
- pui.runAttnProgram()
- pui.runLogic( routine )
- pui.setMLTCHCFLD( field id, checkboxes )
- pui.setPSHBTNFLD( field id, button )
- pui.showHelp()
- pui.submit( post data )
- pui.unmaskScreen()
- Wiki Help API
- pui["brkmsg handler"]
- Startup API
- Mobile API
, multiple selections available,