Updated Row API

Provides run-time access to the Updated Row function and Updated Row State.

Updated Row API Methods

MethodDescription
addUpdatedRowInfo(updatedRowInfo)Adds new Updated Row Info to State
deleteAllUpdatedRowInfo()Deletes all updated rows so no rows have their back colour displayed differently
deleteUpdatedRowInfo(updatedRowInfo)Deletes (clears) an Updated Row Info - so the row is no longer styled differently
getUpdatedRowState()Retrieves Updated Row section from Adaptable State
isUpdatedRowEnabled()Whether Updated Row function is enabled
jumpToRowDisable()Disables the 'Jump To Row' option so that Adaptable will not update its scroll position
jumpToRowEnable()Enables 'Jump To Row' option where Adaptable updates its scroll position to ensure the Updated Row is visible
setDownColor(downColor)Set Colour for when cell data changes upwards in numeric or data columns
setNeutralColor(neutralColor)Set 'No Change' Color i.e. when data update was neither up nor down
setUpColor(upColor)Set Colour for when cell data changes upwards in numeric or data columns
updatedRowDisable()Disables the Updated Row function.
updatedRowEnable()Enables the Updated Row function

See API documentation for full details of all available functions with lists of parameters

More Information