This class represents a region which serves as container of components. Using the PageMgr.renderRegion(Region) or PageMgr.renderRegion(Region, RegionRenderSettings) a region can be rendered.
See Also:
| Property | Description |
|---|---|
ID: String (read-only) | Returns the id of this region. |
size: Number (read-only) | Returns the number of components that would be rendered by this region when calling PageMgr.renderRegion(Region) or PageMgr.renderRegion(Region, RegionRenderSettings). |
visibleComponents: Collection (read-only) | Returns the components that would be rendered by this region when calling PageMgr.renderRegion(Region) or PageMgr.renderRegion(Region, RegionRenderSettings). |
This class does not have a constructor, so you cannot create it directly.
| Method | Description |
|---|---|
| getID() | Returns the id of this region. |
| getSize() | Returns the number of components that would be rendered by this region when calling PageMgr.renderRegion(Region) or PageMgr.renderRegion(Region, RegionRenderSettings). |
| getVisibleComponents() | Returns the components that would be rendered by this region when calling PageMgr.renderRegion(Region) or PageMgr.renderRegion(Region, RegionRenderSettings). |
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
(read-only)Returns the id of this region.
(read-only)Returns the number of components that would be rendered by this region when calling PageMgr.renderRegion(Region) or PageMgr.renderRegion(Region, RegionRenderSettings).
Due to its time and customer group depending nature this call should NOT happen in a pagecached context outside of the processing induced by the above mentioned render methods.
(read-only)Returns the components that would be rendered by this region when calling PageMgr.renderRegion(Region) or PageMgr.renderRegion(Region, RegionRenderSettings).
As visibility is driven by the merchant configured dynamic visibility rules, e.g. scheduling and custom segmentation, this call should NOT happen in a pagecached context outside of the processing induced by the above mentioned render methods.
Returns the id of this region.
Returns:
Returns the number of components that would be rendered by this region when calling PageMgr.renderRegion(Region) or PageMgr.renderRegion(Region, RegionRenderSettings).
Due to its time and customer group depending nature this call should NOT happen in a pagecached context outside of the processing induced by the above mentioned render methods.
Returns:
Returns the components that would be rendered by this region when calling PageMgr.renderRegion(Region) or PageMgr.renderRegion(Region, RegionRenderSettings).
As visibility is driven by the merchant configured dynamic visibility rules, e.g. scheduling and custom segmentation, this call should NOT happen in a pagecached context outside of the processing induced by the above mentioned render methods.
Returns:
j