JavaScript Function References

The following JavaScript functions are available for the triggering of in-page updates:

requestUpdateArea

Parameters:

url

The URL (which may be relative to the current page or resource) to which the update shall be sent. For example:

'platforms'

The above example causes an update to be sent to the location platforms relative to the current page.

sourceAreasStr

A comma-separated list of regions in the form data which affect the outcome of the update. For example:

'/package$1/platforms$1'

Typically, one would use an template extension function to provide such information. For example:

'{template:other-elements(..)}'

Selector fields may be specified in addition to regions:

'{template:selector-name('remove_platform', .)}'

The above example causes the remove_platform selector field to be included in the update.

targetName

The element identifier (specified by an HTML or XML id attribute) within which the outcome of the update shall appear.

targetAreasStr

A comma-separated list of regions in the form data which are affected by the update. See the sourceAreasStr parameter for more details.

elementPath

A simple path into the form data, defining the scope of the update.

requestUpdate

Parameters:

url

The URL (which may be relative to the current page or resource) to which the update shall be sent. See the description of the url parameter for the requestUpdateArea function for more details.

fieldNamesStr

A comma-separated list of fields in the form data which affect the outcome of the update. For example:

'/package$1/name'

Typically, one would use an template extension function to provide such information. For example:

'{template:other-attributes('name', .)}'

The above example causes the field associated with the name attribute on the current element to be included in the update.

targetName

The element identifier (specified by an HTML or XML id attribute) within which the outcome of the update shall appear.

targetFieldNamesStr

A comma-separated list of fields in the form data which are affected by the update. See the fieldNamesStr parameter for more details.

elementPath

A simple path into the form data, defining the scope of the update.