This page is Ready to Use

Notice: The WebPlatform project has been discontinued when the Stewards partnership agreement ended in September 2015. This site has been frozen, and the assets we have created will remain.

getRegionsByContent()

Summary

Returns the static sequence of regions that contain at least part of the supplied target content element.

Method of apis/css-regions/NamedFlowapis/css-regions/NamedFlow

Syntax

var regions = flow.getRegionsByContent(element);

Parameters

element

Data-type
DOM Node

Return Value

Returns an object of type functionfunction

Returns the static sequence of regions that contain at least part of the supplied target content element. The regions are returned in document order.

Examples

Checks if the last paragraph in a flow splits across more than one region

// get flow:
var flow = document.getNamedFlows().namedItem('main');
// get all top-level flow-into elements that contribute to flow:
var elements = flow.getContent();
// get last element:
var lastElement = elements[elements.length-1];
// from within last element, get last paragraph;
var lastPara = lastElement.querySelector('p:last-of-type');
// get regions in which last paragraph displays:
var regions = flow.getRegionsByContent(lastPara);
// check if last paragraph splits across regions:
if (regions.length > 1) {
    // do something?
}

Related specifications

CSS Regions Module Level 1
W3C Working Draft

See also

Related articles

Regions

External resources