Pre-General Availability: 2019-2-1

Interface: region



The region interface is used to access region related methods and properties. You get access to the region interface for a region with the apex.region function.

Plug-in developers can define the behavior of their region by calling apex.region.create.

  • 5.1


element :jQuery

The jQuery object for the region element.

  • jQuery

parentRegionId :string

Identifies the parent (master) region ID, if the region is the detail region of a master detail relationship.

  • string

type :string

Identifies the type of the region. Regions that don't implement a custom region interface have type "generic".

  • string

widgetName :string

For regions that are implemented with a jQuery UI style widget, this is the name of the widget. For other widget implementations it is null. It is used internally by the region#call method.

  • string


alternateLoadingIndicator(pElement, pLoadingIndicator$) → {jQuery}

Return an alternative loading indicator for the given element. Not all regions have this method so check if it exists before calling. For regions that support column items and when the column items may not be visible on the screen at all times this allows the region to place the loading indicator in an appropriate location. This can return the loading indicator passed in or return a completely new loading indicator.

Name Type Description
pElement Element DOM element that may represent a column item.
pLoadingIndicator$ jQuery A loading indicator that can be inserted in to the DOM where desired and returned or ignored.
loadingIndicator jQuery object or null if the region has no alternative for given element.

call(pMethod, …arguments) → {*}

Calls a method on the widget associated with the region. This method only applies to regions that are implemented with a jQuery UI style widget.

Name Type Attributes Description
pMethod string The string name of the widget method.
arguments * <repeatable>
Any number of arguments to be passed to the widget method.
The return value depends on the method called.

The call method is a shorthand for calling methods on a widget. The following example shows an Interactive Grid region with Static ID emp and two equivalent ways of invoking the getSelectedRecords method.

var records1 = apex.region( "emp" ).call( "getSelectedRecords" );
// same result as above but this is more verbose
var records2 = apex.region( "emp" ).widget().interactiveGrid( "getSelectedRecords" );


Cause the region to take focus. Not all native or plug-in regions support taking focus. It is up to the specific region to determine where focus will go. Some regions manage focus such that there is a single tab stop (or limited number of tab stops) and they may put focus to where the user last had focus within the region.

The default implementation sets focus to the first element in the region that is capable of being tabbed to.


The following example will focus the region with Static ID "myRegion".

var region = apex.region( "myRegion" );


Cause the region to get new data from the server or otherwise refresh itself. Not all regions support refresh. Exactly what happens depends on the type of region.

This function should be used in place of the legacy way of refreshing a region, which was to trigger the apexrefresh event on the region element.

The default implementation triggers the legacy apexrefresh event on the region element for backward compatibility with old regions that don't implement this interface.


The following will refresh the region with Static ID "myRegion":

var region = apex.region( "myRegion" );

widget() → {jQuery|null}

Returns the widget associated with the region or null if the region isn't implemented with a widget. Some advanced region types such as Calendar, Interactive Grid, or Tree are implemented using a widget. This function provides access to the widget typically by returning a jQuery object for the widget element. You can then call widget methods on the jQuery object. See also the region#call method.

jQuery object or null if there is no widget associated with the region.
jQuery | null

The following adds a row to an Interactive Grid by using the region widget method to access the interactiveGrid widget interactiveGrid#getActions method and then invoking the selection-add-row action.

apex.region( "myGridRegion" ).widget().interactiveGrid( "getActions" ).invoke( "selection-add-row" );